2 * Copyright © 2009, 2010 Codethink Limited
3 * Copyright © 2010 Red Hat, Inc.
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 licence, or (at your option) any later version.
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.
15 * You should have received a copy of the GNU Lesser General Public
16 * 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.
20 * Authors: Ryan Lortie <desrt@desrt.ca>
21 * Matthias Clasen <mclasen@redhat.com>
24 #ifndef __G_SETTINGS_BACKEND_H__
25 #define __G_SETTINGS_BACKEND_H__
27 #if !defined (G_SETTINGS_ENABLE_BACKEND) && !defined (GIO_COMPILATION)
28 #error "You must define G_SETTINGS_ENABLE_BACKEND before including <gio/gsettingsbackend.h>."
31 #define __GIO_GIO_H_INSIDE__
32 #include <gio/giotypes.h>
33 #undef __GIO_GIO_H_INSIDE__
37 #define G_TYPE_SETTINGS_BACKEND (g_settings_backend_get_type ())
38 #define G_SETTINGS_BACKEND(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
39 G_TYPE_SETTINGS_BACKEND, GSettingsBackend))
40 #define G_SETTINGS_BACKEND_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
41 G_TYPE_SETTINGS_BACKEND, GSettingsBackendClass))
42 #define G_IS_SETTINGS_BACKEND(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
43 G_TYPE_SETTINGS_BACKEND))
44 #define G_IS_SETTINGS_BACKEND_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), \
45 G_TYPE_SETTINGS_BACKEND))
46 #define G_SETTINGS_BACKEND_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
47 G_TYPE_SETTINGS_BACKEND, GSettingsBackendClass))
50 * G_SETTINGS_BACKEND_EXTENSION_POINT_NAME:
52 * Extension point for #GSettingsBackend functionality.
54 #define G_SETTINGS_BACKEND_EXTENSION_POINT_NAME "gsettings-backend"
59 * An implementation of a settings storage repository.
61 typedef struct _GSettingsBackendPrivate GSettingsBackendPrivate
;
62 typedef struct _GSettingsBackendClass GSettingsBackendClass
;
64 struct _GSettingsBackendClass
66 GObjectClass parent_class
;
68 GVariant
* (*read
) (GSettingsBackend
*backend
,
70 const GVariantType
*expected_type
,
71 gboolean default_value
);
73 gboolean (*get_writable
) (GSettingsBackend
*backend
,
76 gboolean (*write
) (GSettingsBackend
*backend
,
80 gboolean (*write_tree
) (GSettingsBackend
*backend
,
83 void (*reset
) (GSettingsBackend
*backend
,
87 void (*subscribe
) (GSettingsBackend
*backend
,
89 void (*unsubscribe
) (GSettingsBackend
*backend
,
91 void (*sync
) (GSettingsBackend
*backend
);
93 GPermission
* (*get_permission
) (GSettingsBackend
*backend
,
99 struct _GSettingsBackend
101 GObject parent_instance
;
104 GSettingsBackendPrivate
*priv
;
107 GType
g_settings_backend_get_type (void);
109 void g_settings_backend_changed (GSettingsBackend
*backend
,
111 gpointer origin_tag
);
112 void g_settings_backend_path_changed (GSettingsBackend
*backend
,
114 gpointer origin_tag
);
115 void g_settings_backend_flatten_tree (GTree
*tree
,
119 void g_settings_backend_keys_changed (GSettingsBackend
*backend
,
121 gchar
const * const *items
,
122 gpointer origin_tag
);
124 void g_settings_backend_path_writable_changed (GSettingsBackend
*backend
,
126 void g_settings_backend_writable_changed (GSettingsBackend
*backend
,
128 void g_settings_backend_changed_tree (GSettingsBackend
*backend
,
130 gpointer origin_tag
);
132 GSettingsBackend
* g_settings_backend_get_default (void);
134 GSettingsBackend
* g_keyfile_settings_backend_new (const gchar
*filename
,
135 const gchar
*root_path
,
136 const gchar
*root_group
);
138 GSettingsBackend
* g_null_settings_backend_new (void);
140 GSettingsBackend
* g_memory_settings_backend_new (void);
144 #endif /* __G_SETTINGS_BACKEND_H__ */