mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-02 15:46:17 +01:00
123116a30c
2007-12-31 Wouter Bolsterlee <wbolster@svn.gnome.org> * gfilemonitor.h: Fixed typo in docs. svn path=/trunk/; revision=6225
119 lines
3.8 KiB
C
119 lines
3.8 KiB
C
/* GIO - GLib Input, Output and Streaming Library
|
|
*
|
|
* Copyright (C) 2006-2007 Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General
|
|
* Public License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*
|
|
* Author: Alexander Larsson <alexl@redhat.com>
|
|
*/
|
|
|
|
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
|
|
#error "Only <gio/gio.h> can be included directly."
|
|
#endif
|
|
|
|
#ifndef __G_FILE_MONITOR_H__
|
|
#define __G_FILE_MONITOR_H__
|
|
|
|
#include <glib-object.h>
|
|
#include <gio/gfile.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
#define G_TYPE_FILE_MONITOR (g_file_monitor_get_type ())
|
|
#define G_FILE_MONITOR(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_MONITOR, GFileMonitor))
|
|
#define G_FILE_MONITOR_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_MONITOR, GFileMonitorClass))
|
|
#define G_IS_FILE_MONITOR(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_MONITOR))
|
|
#define G_IS_FILE_MONITOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_MONITOR))
|
|
#define G_FILE_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_MONITOR, GFileMonitorClass))
|
|
|
|
/**
|
|
* GFileMonitorEvent:
|
|
* @G_FILE_MONITOR_EVENT_CHANGED: a file changed.
|
|
* @G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT: a hint that this was probably the last change in a set of changes.
|
|
* @G_FILE_MONITOR_EVENT_DELETED: a file was deleted.
|
|
* @G_FILE_MONITOR_EVENT_CREATED: a file was created.
|
|
* @G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED: a file attribute was changed.
|
|
* @G_FILE_MONITOR_EVENT_PRE_UNMOUNT: the file location will soon be unmounted.
|
|
* @G_FILE_MONITOR_EVENT_UNMOUNTED: the file location was unmounted.
|
|
*
|
|
* Specifies what type of event a monitor event is.
|
|
**/
|
|
typedef enum {
|
|
G_FILE_MONITOR_EVENT_CHANGED,
|
|
G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
|
|
G_FILE_MONITOR_EVENT_DELETED,
|
|
G_FILE_MONITOR_EVENT_CREATED,
|
|
G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
|
|
G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
|
|
G_FILE_MONITOR_EVENT_UNMOUNTED
|
|
} GFileMonitorEvent;
|
|
|
|
typedef struct _GFileMonitorClass GFileMonitorClass;
|
|
typedef struct _GFileMonitorPrivate GFileMonitorPrivate;
|
|
|
|
/**
|
|
* GFileMonitor:
|
|
*
|
|
* Watches for changes to a file.
|
|
**/
|
|
struct _GFileMonitor
|
|
{
|
|
GObject parent_instance;
|
|
|
|
/*< private >*/
|
|
GFileMonitorPrivate *priv;
|
|
};
|
|
|
|
struct _GFileMonitorClass
|
|
{
|
|
GObjectClass parent_class;
|
|
|
|
/* Signals */
|
|
void (* changed) (GFileMonitor* monitor,
|
|
GFile* file,
|
|
GFile* other_file,
|
|
GFileMonitorEvent event_type);
|
|
|
|
/* Virtual Table */
|
|
gboolean (*cancel)(GFileMonitor* monitor);
|
|
|
|
/*< private >*/
|
|
/* Padding for future expansion */
|
|
void (*_g_reserved1) (void);
|
|
void (*_g_reserved2) (void);
|
|
void (*_g_reserved3) (void);
|
|
void (*_g_reserved4) (void);
|
|
void (*_g_reserved5) (void);
|
|
};
|
|
|
|
GType g_file_monitor_get_type (void) G_GNUC_CONST;
|
|
|
|
gboolean g_file_monitor_cancel (GFileMonitor *monitor);
|
|
gboolean g_file_monitor_is_cancelled (GFileMonitor *monitor);
|
|
void g_file_monitor_set_rate_limit (GFileMonitor *monitor,
|
|
int limit_msecs);
|
|
|
|
|
|
/* For implementations */
|
|
void g_file_monitor_emit_event (GFileMonitor *monitor,
|
|
GFile *file,
|
|
GFile *other_file,
|
|
GFileMonitorEvent event_type);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_FILE_MONITOR_H__ */
|