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