Docs: don't use <footnote>
[platform/upstream/glib.git] / gio / glocaldirectorymonitor.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_LOCAL_DIRECTORY_MONITOR_H__
24 #define __G_LOCAL_DIRECTORY_MONITOR_H__
25
26 #include <gio/gfilemonitor.h>
27
28 #include "gunixmounts.h"
29
30 G_BEGIN_DECLS
31
32 #define G_TYPE_LOCAL_DIRECTORY_MONITOR          (g_local_directory_monitor_get_type ())
33 #define G_LOCAL_DIRECTORY_MONITOR(o)            (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_LOCAL_DIRECTORY_MONITOR, GLocalDirectoryMonitor))
34 #define G_LOCAL_DIRECTORY_MONITOR_CLASS(k)      (G_TYPE_CHECK_CLASS_CAST ((k), G_TYPE_LOCAL_DIRECTORY_MONITOR, GLocalDirectoryMonitorClass))
35 #define G_IS_LOCAL_DIRECTORY_MONITOR(o)         (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_LOCAL_DIRECTORY_MONITOR))
36 #define G_IS_LOCAL_DIRECTORY_MONITOR_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_LOCAL_DIRECTORY_MONITOR))
37 #define G_LOCAL_DIRECTORY_MONITOR_GET_CLASS(o)  (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_LOCAL_DIRECTORY_MONITOR, GLocalDirectoryMonitorClass))
38
39 #define G_LOCAL_DIRECTORY_MONITOR_EXTENSION_POINT_NAME "gio-local-directory-monitor"
40 #define G_NFS_DIRECTORY_MONITOR_EXTENSION_POINT_NAME   "gio-nfs-directory-monitor"
41
42 typedef struct _GLocalDirectoryMonitor      GLocalDirectoryMonitor;
43 typedef struct _GLocalDirectoryMonitorClass GLocalDirectoryMonitorClass;
44
45 struct _GLocalDirectoryMonitor
46 {
47   GFileMonitor parent_instance;
48
49   gchar             *dirname;
50   GFileMonitorFlags  flags;
51   /* For mount emulation */
52   gboolean           was_mounted;
53   GUnixMountMonitor *mount_monitor;
54 };
55
56 struct _GLocalDirectoryMonitorClass
57 {
58   GFileMonitorClass parent_class;
59
60   gboolean mount_notify;
61
62   gboolean (* is_supported) (void);
63   void     (* start)        (GLocalDirectoryMonitor *local_monitor);
64 };
65
66 #ifdef G_OS_UNIX
67 GLIB_AVAILABLE_IN_ALL
68 #endif
69 GType           g_local_directory_monitor_get_type (void) G_GNUC_CONST;
70
71 GFileMonitor * _g_local_directory_monitor_new      (const char         *dirname,
72                                                     GFileMonitorFlags   flags,
73                                                     GMainContext       *context,
74                                                     gboolean            is_remote_fs,
75                                                     gboolean            do_start,
76                                                     GError            **error);
77 void            g_local_directory_monitor_start    (GLocalDirectoryMonitor *local_monitor);
78
79 /* Actually in glocalfile.c */
80 GLocalDirectoryMonitor *  g_local_directory_monitor_new_in_worker (const char         *pathname,
81                                                                    GFileMonitorFlags   flags,
82                                                                    GError            **error);
83
84 G_END_DECLS
85
86 #endif /* __G_LOCAL_DIRECTORY_MONITOR_H__ */