• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 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, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  */
22 
23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
24 #error "Only <gio/gio.h> can be included directly."
25 #endif
26 
27 #ifndef __G_FILE_MONITOR_H__
28 #define __G_FILE_MONITOR_H__
29 
30 #include <gio/giotypes.h>
31 
32 G_BEGIN_DECLS
33 
34 #define G_TYPE_FILE_MONITOR         (g_file_monitor_get_type ())
35 #define G_FILE_MONITOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_MONITOR, GFileMonitor))
36 #define G_FILE_MONITOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_MONITOR, GFileMonitorClass))
37 #define G_IS_FILE_MONITOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_MONITOR))
38 #define G_IS_FILE_MONITOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_MONITOR))
39 #define G_FILE_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_MONITOR, GFileMonitorClass))
40 
41 typedef struct _GFileMonitorClass       GFileMonitorClass;
42 typedef struct _GFileMonitorPrivate	GFileMonitorPrivate;
43 
44 /**
45  * GFileMonitor:
46  *
47  * Watches for changes to a file.
48  **/
49 struct _GFileMonitor
50 {
51   GObject parent_instance;
52 
53   /*< private >*/
54   GFileMonitorPrivate *priv;
55 };
56 
57 struct _GFileMonitorClass
58 {
59   GObjectClass parent_class;
60 
61   /* Signals */
62   void     (* changed) (GFileMonitor      *monitor,
63                         GFile             *file,
64                         GFile             *other_file,
65                         GFileMonitorEvent  event_type);
66 
67   /* Virtual Table */
68   gboolean (* cancel)  (GFileMonitor      *monitor);
69 
70   /*< private >*/
71   /* Padding for future expansion */
72   void (*_g_reserved1) (void);
73   void (*_g_reserved2) (void);
74   void (*_g_reserved3) (void);
75   void (*_g_reserved4) (void);
76   void (*_g_reserved5) (void);
77 };
78 
79 GType    g_file_monitor_get_type       (void) G_GNUC_CONST;
80 
81 gboolean g_file_monitor_cancel         (GFileMonitor      *monitor);
82 gboolean g_file_monitor_is_cancelled   (GFileMonitor      *monitor);
83 void     g_file_monitor_set_rate_limit (GFileMonitor      *monitor,
84                                         int                limit_msecs);
85 
86 
87 /* For implementations */
88 void     g_file_monitor_emit_event     (GFileMonitor      *monitor,
89                                         GFile             *child,
90                                         GFile             *other_file,
91                                         GFileMonitorEvent  event_type);
92 
93 G_END_DECLS
94 
95 #endif /* __G_FILE_MONITOR_H__ */
96