1 /* GIO - GLib Input, Output and Streaming Library 2 * 3 * Copyright (C) 2006-2007 Red Hat, Inc. 4 * 5 * This library is free software; you can redistribute it and/or 6 * modify it under the terms of the GNU Lesser General Public 7 * License as published by the Free Software Foundation; either 8 * version 2.1 of the License, or (at your option) any later version. 9 * 10 * This library is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 * Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General 16 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>. 17 * 18 * Author: Alexander Larsson <alexl@redhat.com> 19 */ 20 21 #ifndef __G_FILE_MONITOR_H__ 22 #define __G_FILE_MONITOR_H__ 23 24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION) 25 #error "Only <gio/gio.h> can be included directly." 26 #endif 27 28 #include <gio/giotypes.h> 29 30 G_BEGIN_DECLS 31 32 #define G_TYPE_FILE_MONITOR (g_file_monitor_get_type ()) 33 #define G_FILE_MONITOR(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_MONITOR, GFileMonitor)) 34 #define G_FILE_MONITOR_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_MONITOR, GFileMonitorClass)) 35 #define G_IS_FILE_MONITOR(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_MONITOR)) 36 #define G_IS_FILE_MONITOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_MONITOR)) 37 #define G_FILE_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_MONITOR, GFileMonitorClass)) 38 39 typedef struct _GFileMonitorClass GFileMonitorClass; 40 typedef struct _GFileMonitorPrivate GFileMonitorPrivate; 41 42 /** 43 * GFileMonitor: 44 * 45 * Watches for changes to a file. 46 **/ 47 struct _GFileMonitor 48 { 49 GObject parent_instance; 50 51 /*< private >*/ 52 GFileMonitorPrivate *priv; 53 }; 54 55 struct _GFileMonitorClass 56 { 57 GObjectClass parent_class; 58 59 /* Signals */ 60 void (* changed) (GFileMonitor *monitor, 61 GFile *file, 62 GFile *other_file, 63 GFileMonitorEvent event_type); 64 65 /* Virtual Table */ 66 gboolean (* cancel) (GFileMonitor *monitor); 67 68 /*< private >*/ 69 /* Padding for future expansion */ 70 void (*_g_reserved1) (void); 71 void (*_g_reserved2) (void); 72 void (*_g_reserved3) (void); 73 void (*_g_reserved4) (void); 74 void (*_g_reserved5) (void); 75 }; 76 77 GLIB_AVAILABLE_IN_ALL 78 GType g_file_monitor_get_type (void) G_GNUC_CONST; 79 80 GLIB_AVAILABLE_IN_ALL 81 gboolean g_file_monitor_cancel (GFileMonitor *monitor); 82 GLIB_AVAILABLE_IN_ALL 83 gboolean g_file_monitor_is_cancelled (GFileMonitor *monitor); 84 GLIB_AVAILABLE_IN_ALL 85 void g_file_monitor_set_rate_limit (GFileMonitor *monitor, 86 gint limit_msecs); 87 88 89 /* For implementations */ 90 GLIB_AVAILABLE_IN_ALL 91 void g_file_monitor_emit_event (GFileMonitor *monitor, 92 GFile *child, 93 GFile *other_file, 94 GFileMonitorEvent event_type); 95 96 G_END_DECLS 97 98 #endif /* __G_FILE_MONITOR_H__ */ 99