gio/gdirectorymonitor.h

   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 #ifndef __G_DIRECTORY_MONITOR_H__
  24 #define __G_DIRECTORY_MONITOR_H__
  25
  26 #include <glib-object.h>
  27 #include <gio/gfile.h>
  28 #include <gio/gfilemonitor.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_DIRECTORY_MONITOR         (g_directory_monitor_get_type ())
  33 #define G_DIRECTORY_MONITOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_DIRECTORY_MONITOR, GDirectoryMonitor))
  34 #define G_DIRECTORY_MONITOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_DIRECTORY_MONITOR, GDirectoryMonitorClass))
  35 #define G_IS_DIRECTORY_MONITOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_DIRECTORY_MONITOR))
  36 #define G_IS_DIRECTORY_MONITOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_DIRECTORY_MONITOR))
  37 #define G_DIRECTORY_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_DIRECTORY_MONITOR, GDirectoryMonitorClass))
  38
  39 typedef struct _GDirectoryMonitorClass   GDirectoryMonitorClass;
  40 typedef struct _GDirectoryMonitorPrivate GDirectoryMonitorPrivate;
  41
  42 struct _GDirectoryMonitor
  43 {
  44   GObject parent;
  45
  46   /*< private >*/
  47   GDirectoryMonitorPrivate *priv;
  48 };
  49
  50 struct _GDirectoryMonitorClass
  51 {
  52   GObjectClass parent_class;
  53
  54   /* Signals */
  55   void (* changed) (GDirectoryMonitor* monitor,
  56                     GFile *child,
  57                     GFile *other_file,
  58                     GFileMonitorEvent event_type);
  59
  60   /* Virtual Table */
  61   gboolean      (*cancel)(GDirectoryMonitor* monitor);
  62
  63   /* Padding for future expansion */
  64   void (*_g_reserved1) (void);
  65   void (*_g_reserved2) (void);
  66   void (*_g_reserved3) (void);
  67   void (*_g_reserved4) (void);
  68   void (*_g_reserved5) (void);
  69 };
  70
  71 GType g_directory_monitor_get_type (void) G_GNUC_CONST;
  72
  73 gboolean g_directory_monitor_cancel         (GDirectoryMonitor *monitor);
  74 gboolean g_directory_monitor_is_cancelled   (GDirectoryMonitor *monitor);
  75 void     g_directory_monitor_set_rate_limit (GDirectoryMonitor *monitor,
  76                                              int                limit_msecs);
  77
  78 /* For implementations */
  79 void g_directory_monitor_emit_event (GDirectoryMonitor      *monitor,
  80                                      GFile                  *child,
  81                                      GFile                  *other_file,
  82                                      GFileMonitorEvent       event_type);
  83
  84 G_END_DECLS
  85
  86 #endif /* __G_DIRECTORY_MONITOR_H__ */