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 /**
  43  * GDirectoryMonitor:
  44  * @parent_instance: The parent class.
  45  *
  46  * Implements a monitor on the given #GFile that points to a directory.
  47  **/
  48 struct _GDirectoryMonitor
  49 {
  50   GObject parent_instance;
  51
  52   /*< private >*/
  53   GDirectoryMonitorPrivate *priv;
  54 };
  55
  56 struct _GDirectoryMonitorClass
  57 {
  58   GObjectClass parent_class;
  59
  60   /* Signals */
  61   void (* changed) (GDirectoryMonitor* monitor,
  62                     GFile *child,
  63                     GFile *other_file,
  64                     GFileMonitorEvent event_type);
  65
  66   /* Virtual Table */
  67   gboolean      (*cancel)(GDirectoryMonitor* monitor);
  68
  69   /*< private >*/
  70   /* Padding for future expansion */
  71   void (*_g_reserved1) (void);
  72   void (*_g_reserved2) (void);
  73   void (*_g_reserved3) (void);
  74   void (*_g_reserved4) (void);
  75   void (*_g_reserved5) (void);
  76 };
  77
  78 GType g_directory_monitor_get_type (void) G_GNUC_CONST;
  79
  80 gboolean g_directory_monitor_cancel         (GDirectoryMonitor *monitor);
  81 gboolean g_directory_monitor_is_cancelled   (GDirectoryMonitor *monitor);
  82 void     g_directory_monitor_set_rate_limit (GDirectoryMonitor *monitor,
  83                                              int                limit_msecs);
  84
  85 /* For implementations */
  86 void g_directory_monitor_emit_event (GDirectoryMonitor      *monitor,
  87                                      GFile                  *child,
  88                                      GFile                  *other_file,
  89                                      GFileMonitorEvent       event_type);
  90
  91 G_END_DECLS
  92
  93 #endif /* __G_DIRECTORY_MONITOR_H__ */