gio/gfilemonitor.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_FILE_MONITOR_H__
  24 #define __G_FILE_MONITOR_H__
  25
  26 #include <glib-object.h>
  27 #include <gio/gfile.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define G_TYPE_FILE_MONITOR         (g_file_monitor_get_type ())
  32 #define G_FILE_MONITOR(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_MONITOR, GFileMonitor))
  33 #define G_FILE_MONITOR_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_MONITOR, GFileMonitorClass))
  34 #define G_IS_FILE_MONITOR(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_MONITOR))
  35 #define G_IS_FILE_MONITOR_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_MONITOR))
  36 #define G_FILE_MONITOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_MONITOR, GFileMonitorClass))
  37
  38 /**
  39  * GFileMonitorEvent:
  40  * @G_FILE_MONITOR_EVENT_CHANGED: a file changed.
  41  * @G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT: a hint that this was probably the last change in a set of changes.
  42  * @G_FILE_MONITOR_EVENT_DELETED: a file was deleted.
  43  * @G_FILE_MONITOR_EVENT_CREATED: a file was created.
  44  * @G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED: a file attribute was changed.
  45  * @G_FILE_MONITOR_EVENT_PRE_UNMOUNT: the file location will soon be unmounted.
  46  * @G_FILE_MONITOR_EVENT_UNMOUNTED: the file location was be unmounted.
  47  *
  48  * Specifies what type of event a monitor event is.
  49  **/
  50 typedef enum {
  51   G_FILE_MONITOR_EVENT_CHANGED,
  52   G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
  53   G_FILE_MONITOR_EVENT_DELETED,
  54   G_FILE_MONITOR_EVENT_CREATED,
  55   G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
  56   G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
  57   G_FILE_MONITOR_EVENT_UNMOUNTED
  58 } GFileMonitorEvent;
  59
  60 typedef struct _GFileMonitorClass       GFileMonitorClass;
  61 typedef struct _GFileMonitorPrivate     GFileMonitorPrivate;
  62
  63 /**
  64  * GFileMonitor:
  65  *
  66  * Watches for changes to a file.
  67  **/
  68 struct _GFileMonitor
  69 {
  70   GObject parent;
  71
  72   /*< private >*/
  73   GFileMonitorPrivate *priv;
  74 };
  75
  76 struct _GFileMonitorClass
  77 {
  78   GObjectClass parent_class;
  79
  80   /* Signals */
  81   void (* changed) (GFileMonitor* monitor,
  82                     GFile* file,
  83                     GFile* other_file,
  84                     GFileMonitorEvent event_type);
  85
  86   /* Virtual Table */
  87   gboolean      (*cancel)(GFileMonitor* monitor);
  88
  89   /*< private >*/
  90   /* Padding for future expansion */
  91   void (*_g_reserved1) (void);
  92   void (*_g_reserved2) (void);
  93   void (*_g_reserved3) (void);
  94   void (*_g_reserved4) (void);
  95   void (*_g_reserved5) (void);
  96 };
  97
  98 GType g_file_monitor_get_type (void) G_GNUC_CONST;
  99
 100 gboolean g_file_monitor_cancel         (GFileMonitor *monitor);
 101 gboolean g_file_monitor_is_cancelled   (GFileMonitor *monitor);
 102 void     g_file_monitor_set_rate_limit (GFileMonitor *monitor,
 103                                         int           limit_msecs);
 104
 105
 106 /* For implementations */
 107 void g_file_monitor_emit_event (GFileMonitor      *monitor,
 108                                 GFile             *file,
 109                                 GFile             *other_file,
 110                                 GFileMonitorEvent  event_type);
 111
 112 G_END_DECLS
 113
 114 #endif /* __G_FILE_MONITOR_H__ */