glib-2.0/gio/gfilemonitor.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright (C) 2006-2007 Red Hat, Inc.
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Author: Alexander Larsson <alexl@redhat.com>
0021  */
0022
0023 #ifndef __G_FILE_MONITOR_H__
0024 #define __G_FILE_MONITOR_H__
0025
0026 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0027 #error "Only <gio/gio.h> can be included directly."
0028 #endif
0029
0030 #include <gio/giotypes.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_FILE_MONITOR         (g_file_monitor_get_type ())
0035 #define G_FILE_MONITOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_MONITOR, GFileMonitor))
0036 #define G_FILE_MONITOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_MONITOR, GFileMonitorClass))
0037 #define G_IS_FILE_MONITOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_MONITOR))
0038 #define G_IS_FILE_MONITOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_MONITOR))
0039 #define G_FILE_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_MONITOR, GFileMonitorClass))
0040
0041 typedef struct _GFileMonitorClass       GFileMonitorClass;
0042 typedef struct _GFileMonitorPrivate GFileMonitorPrivate;
0043
0044 struct _GFileMonitor
0045 {
0046   GObject parent_instance;
0047
0048   /*< private >*/
0049   GFileMonitorPrivate *priv;
0050 };
0051
0052 struct _GFileMonitorClass
0053 {
0054   GObjectClass parent_class;
0055
0056   /* Signals */
0057   void     (* changed) (GFileMonitor      *monitor,
0058                         GFile             *file,
0059                         GFile             *other_file,
0060                         GFileMonitorEvent  event_type);
0061
0062   /* Virtual Table */
0063   gboolean (* cancel)  (GFileMonitor      *monitor);
0064
0065   /*< private >*/
0066   /* Padding for future expansion */
0067   void (*_g_reserved1) (void);
0068   void (*_g_reserved2) (void);
0069   void (*_g_reserved3) (void);
0070   void (*_g_reserved4) (void);
0071   void (*_g_reserved5) (void);
0072 };
0073
0074 GIO_AVAILABLE_IN_ALL
0075 GType    g_file_monitor_get_type       (void) G_GNUC_CONST;
0076
0077 GIO_AVAILABLE_IN_ALL
0078 gboolean g_file_monitor_cancel         (GFileMonitor      *monitor);
0079 GIO_AVAILABLE_IN_ALL
0080 gboolean g_file_monitor_is_cancelled   (GFileMonitor      *monitor);
0081 GIO_AVAILABLE_IN_ALL
0082 void     g_file_monitor_set_rate_limit (GFileMonitor      *monitor,
0083                                         gint               limit_msecs);
0084
0085
0086 /* For implementations */
0087 GIO_AVAILABLE_IN_ALL
0088 void     g_file_monitor_emit_event     (GFileMonitor      *monitor,
0089                                         GFile             *child,
0090                                         GFile             *other_file,
0091                                         GFileMonitorEvent  event_type);
0092
0093 G_END_DECLS
0094
0095 #endif /* __G_FILE_MONITOR_H__ */