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 #include <glib-object.h>
35 #define G_TYPE_SETTINGS_BACKEND (g_settings_backend_get_type ())
36 #define G_SETTINGS_BACKEND(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
37 G_TYPE_SETTINGS_BACKEND, GSettingsBackend))
38 #define G_SETTINGS_BACKEND_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
39 G_TYPE_SETTINGS_BACKEND, GSettingsBackendClass))
40 #define G_IS_SETTINGS_BACKEND(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
41 G_TYPE_SETTINGS_BACKEND))
42 #define G_IS_SETTINGS_BACKEND_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), \
43 G_TYPE_SETTINGS_BACKEND))
44 #define G_SETTINGS_BACKEND_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
45 G_TYPE_SETTINGS_BACKEND, GSettingsBackendClass))
48 * G_SETTINGS_BACKEND_EXTENSION_POINT_NAME:
50 * Extension point for #GSettingsBackend functionality.
52 #define G_SETTINGS_BACKEND_EXTENSION_POINT_NAME "gsettings-backend"
57 * An implementation of a settings storage repository.
59 typedef struct _GSettingsBackendPrivate GSettingsBackendPrivate;
60 typedef struct _GSettingsBackendClass GSettingsBackendClass;
61 typedef struct _GSettingsBackend GSettingsBackend;
64 struct _GSettingsBackendClass
66 GObjectClass parent_class;
68 gboolean (*supports_context) (const gchar *context);
70 GVariant * (*read) (GSettingsBackend *backend,
72 const GVariantType *expected_type,
73 gboolean default_value);
74 gchar ** (*list) (GSettingsBackend *backend,
77 gboolean (*write) (GSettingsBackend *backend,
81 gboolean (*write_keys) (GSettingsBackend *backend,
84 void (*reset) (GSettingsBackend *backend,
87 void (*reset_path) (GSettingsBackend *backend,
90 gboolean (*get_writable) (GSettingsBackend *backend,
92 void (*subscribe) (GSettingsBackend *backend,
94 void (*unsubscribe) (GSettingsBackend *backend,
98 struct _GSettingsBackend
100 GObject parent_instance;
103 GSettingsBackendPrivate *priv;
106 GType g_settings_backend_get_type (void);
108 void g_settings_backend_setup (const gchar *context,
109 GSettingsBackend *backend);
110 void g_settings_backend_setup_keyfile (const gchar *context,
111 const gchar *filename);
113 void g_settings_backend_changed (GSettingsBackend *backend,
115 gpointer origin_tag);
116 void g_settings_backend_path_changed (GSettingsBackend *backend,
118 gpointer origin_tag);
119 void g_settings_backend_flatten_tree (GTree *tree,
123 void g_settings_backend_keys_changed (GSettingsBackend *backend,
125 gchar const * const *items,
126 gpointer origin_tag);
128 void g_settings_backend_path_writable_changed(GSettingsBackend *backend,
130 void g_settings_backend_writable_changed (GSettingsBackend *backend,
132 void g_settings_backend_changed_tree (GSettingsBackend *backend,
134 gpointer origin_tag);
138 #endif /* __G_SETTINGS_BACKEND_H__ */