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 typedef enum {
  39   G_FILE_MONITOR_EVENT_CHANGED,
  40   G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT,
  41   G_FILE_MONITOR_EVENT_DELETED,
  42   G_FILE_MONITOR_EVENT_CREATED,
  43   G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED,
  44   G_FILE_MONITOR_EVENT_PRE_UNMOUNT,
  45   G_FILE_MONITOR_EVENT_UNMOUNTED
  46 } GFileMonitorEvent;
  47
  48 typedef struct _GFileMonitorClass       GFileMonitorClass;
  49 typedef struct _GFileMonitorPrivate     GFileMonitorPrivate;
  50
  51 struct _GFileMonitor
  52 {
  53   GObject parent;
  54
  55   /*< private >*/
  56   GFileMonitorPrivate *priv;
  57 };
  58
  59 struct _GFileMonitorClass
  60 {
  61   GObjectClass parent_class;
  62
  63   /* Signals */
  64   void (* changed) (GFileMonitor* monitor,
  65                     GFile* file,
  66                     GFile* other_file,
  67                     GFileMonitorEvent event_type);
  68
  69   /* Virtual Table */
  70   gboolean      (*cancel)(GFileMonitor* monitor);
  71
  72
  73   /* Padding for future expansion */
  74   void (*_g_reserved1) (void);
  75   void (*_g_reserved2) (void);
  76   void (*_g_reserved3) (void);
  77   void (*_g_reserved4) (void);
  78   void (*_g_reserved5) (void);
  79 };
  80
  81 GType g_file_monitor_get_type (void) G_GNUC_CONST;
  82
  83 gboolean g_file_monitor_cancel         (GFileMonitor *monitor);
  84 gboolean g_file_monitor_is_cancelled   (GFileMonitor *monitor);
  85 void     g_file_monitor_set_rate_limit (GFileMonitor *monitor,
  86                                         int           limit_msecs);
  87
  88
  89 /* For implementations */
  90 void g_file_monitor_emit_event (GFileMonitor      *monitor,
  91                                 GFile             *file,
  92                                 GFile             *other_file,
  93                                 GFileMonitorEvent  event_type);
  94
  95 G_END_DECLS
  96
  97 #endif /* __G_FILE_MONITOR_H__ */