glib (2.79.0)
1 /* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 *
5 * SPDX-License-Identifier: LGPL-2.1-or-later
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Author: Alexander Larsson <alexl@redhat.com>
21 */
22
23 #ifndef __G_FILE_MONITOR_H__
24 #define __G_FILE_MONITOR_H__
25
26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27 #error "Only <gio/gio.h> can be included directly."
28 #endif
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 struct _GFileMonitor
45 {
46 GObject parent_instance;
47
48 /*< private >*/
49 GFileMonitorPrivate *priv;
50 };
51
52 struct _GFileMonitorClass
53 {
54 GObjectClass parent_class;
55
56 /* Signals */
57 void (* changed) (GFileMonitor *monitor,
58 GFile *file,
59 GFile *other_file,
60 GFileMonitorEvent event_type);
61
62 /* Virtual Table */
63 gboolean (* cancel) (GFileMonitor *monitor);
64
65 /*< private >*/
66 /* Padding for future expansion */
67 void (*_g_reserved1) (void);
68 void (*_g_reserved2) (void);
69 void (*_g_reserved3) (void);
70 void (*_g_reserved4) (void);
71 void (*_g_reserved5) (void);
72 };
73
74 GIO_AVAILABLE_IN_ALL
75 GType g_file_monitor_get_type (void) G_GNUC_CONST;
76
77 GIO_AVAILABLE_IN_ALL
78 gboolean g_file_monitor_cancel (GFileMonitor *monitor);
79 GIO_AVAILABLE_IN_ALL
80 gboolean g_file_monitor_is_cancelled (GFileMonitor *monitor);
81 GIO_AVAILABLE_IN_ALL
82 void g_file_monitor_set_rate_limit (GFileMonitor *monitor,
83 gint limit_msecs);
84
85
86 /* For implementations */
87 GIO_AVAILABLE_IN_ALL
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__ */