gsettingsbackend.h 8.31 KB
Newer Older
1 2 3 4 5 6 7
/*
 * Copyright © 2009, 2010 Codethink Limited
 * Copyright © 2010 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
8
 * version 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
16
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18 19 20 21 22 23 24 25 26 27 28
 *
 * Authors: Ryan Lortie <desrt@desrt.ca>
 *          Matthias Clasen <mclasen@redhat.com>
 */

#ifndef __G_SETTINGS_BACKEND_H__
#define __G_SETTINGS_BACKEND_H__

#if !defined (G_SETTINGS_ENABLE_BACKEND) && !defined (GIO_COMPILATION)
#error "You must define G_SETTINGS_ENABLE_BACKEND before including <gio/gsettingsbackend.h>."
#endif

29 30 31
#define __GIO_GIO_H_INSIDE__
#include <gio/giotypes.h>
#undef __GIO_GIO_H_INSIDE__
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

G_BEGIN_DECLS

#define G_TYPE_SETTINGS_BACKEND                             (g_settings_backend_get_type ())
#define G_SETTINGS_BACKEND(inst)                            (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
                                                             G_TYPE_SETTINGS_BACKEND, GSettingsBackend))
#define G_SETTINGS_BACKEND_CLASS(class)                     (G_TYPE_CHECK_CLASS_CAST ((class),                       \
                                                             G_TYPE_SETTINGS_BACKEND, GSettingsBackendClass))
#define G_IS_SETTINGS_BACKEND(inst)                         (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
                                                             G_TYPE_SETTINGS_BACKEND))
#define G_IS_SETTINGS_BACKEND_CLASS(class)                  (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
                                                             G_TYPE_SETTINGS_BACKEND))
#define G_SETTINGS_BACKEND_GET_CLASS(inst)                  (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
                                                             G_TYPE_SETTINGS_BACKEND, GSettingsBackendClass))

/**
 * G_SETTINGS_BACKEND_EXTENSION_POINT_NAME:
 *
 * Extension point for #GSettingsBackend functionality.
 **/
#define G_SETTINGS_BACKEND_EXTENSION_POINT_NAME "gsettings-backend"

/**
 * GSettingsBackend:
 *
 * An implementation of a settings storage repository.
 **/
typedef struct _GSettingsBackendPrivate                     GSettingsBackendPrivate;
typedef struct _GSettingsBackendClass                       GSettingsBackendClass;

62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
/**
 * GSettingsBackendClass:
 * @read: virtual method to read a key's value
 * @get_writable: virtual method to get if a key is writable
 * @write: virtual method to change key's value
 * @write_tree: virtual method to change a tree of keys
 * @reset: virtual method to reset state
 * @subscribe: virtual method to subscribe to key changes
 * @unsubscribe: virtual method to unsubscribe to key changes
 * @sync: virtual method to sync state
 * @get_permission: virtual method to get permission of a key
 * @read_user_value: virtual method to read user's key value
 *
 * Class structure for #GSettingsBackend.
 */
77 78 79 80
struct _GSettingsBackendClass
{
  GObjectClass parent_class;

81 82 83 84
  GVariant *    (*read)             (GSettingsBackend    *backend,
                                     const gchar         *key,
                                     const GVariantType  *expected_type,
                                     gboolean             default_value);
85 86 87 88

  gboolean      (*get_writable)     (GSettingsBackend    *backend,
                                     const gchar         *key);

89 90 91 92
  gboolean      (*write)            (GSettingsBackend    *backend,
                                     const gchar         *key,
                                     GVariant            *value,
                                     gpointer             origin_tag);
93
  gboolean      (*write_tree)       (GSettingsBackend    *backend,
94 95 96 97 98
                                     GTree               *tree,
                                     gpointer             origin_tag);
  void          (*reset)            (GSettingsBackend    *backend,
                                     const gchar         *key,
                                     gpointer             origin_tag);
99

100 101 102 103 104 105 106 107 108
  void          (*subscribe)        (GSettingsBackend    *backend,
                                     const gchar         *name);
  void          (*unsubscribe)      (GSettingsBackend    *backend,
                                     const gchar         *name);
  void          (*sync)             (GSettingsBackend    *backend);

  GPermission * (*get_permission)   (GSettingsBackend    *backend,
                                     const gchar         *path);

109 110 111 112
  GVariant *    (*read_user_value)  (GSettingsBackend    *backend,
                                     const gchar         *key,
                                     const GVariantType  *expected_type);

113
  /*< private >*/
114
  gpointer padding[23];
115 116 117 118 119 120 121 122 123 124
};

struct _GSettingsBackend
{
  GObject parent_instance;

  /*< private >*/
  GSettingsBackendPrivate *priv;
};

125
GLIB_AVAILABLE_IN_ALL
126
GType                   g_settings_backend_get_type                     (void);
127

128
GLIB_AVAILABLE_IN_ALL
129
void                    g_settings_backend_changed                      (GSettingsBackend    *backend,
130 131
                                                                         const gchar         *key,
                                                                         gpointer             origin_tag);
132
GLIB_AVAILABLE_IN_ALL
133
void                    g_settings_backend_path_changed                 (GSettingsBackend    *backend,
134 135
                                                                         const gchar         *path,
                                                                         gpointer             origin_tag);
136
GLIB_AVAILABLE_IN_ALL
137
void                    g_settings_backend_flatten_tree                 (GTree               *tree,
138 139 140
                                                                         gchar              **path,
                                                                         const gchar       ***keys,
                                                                         GVariant          ***values);
141
GLIB_AVAILABLE_IN_ALL
142
void                    g_settings_backend_keys_changed                 (GSettingsBackend    *backend,
143 144 145 146
                                                                         const gchar         *path,
                                                                         gchar const * const *items,
                                                                         gpointer             origin_tag);

147
GLIB_AVAILABLE_IN_ALL
148
void                    g_settings_backend_path_writable_changed        (GSettingsBackend    *backend,
149
                                                                         const gchar         *path);
150
GLIB_AVAILABLE_IN_ALL
151
void                    g_settings_backend_writable_changed             (GSettingsBackend    *backend,
152
                                                                         const gchar         *key);
153
GLIB_AVAILABLE_IN_ALL
154
void                    g_settings_backend_changed_tree                 (GSettingsBackend    *backend,
155 156 157
                                                                         GTree               *tree,
                                                                         gpointer             origin_tag);

158
GLIB_AVAILABLE_IN_ALL
159 160
GSettingsBackend *      g_settings_backend_get_default                  (void);

161
GLIB_AVAILABLE_IN_ALL
162 163 164
GSettingsBackend *      g_keyfile_settings_backend_new                  (const gchar         *filename,
                                                                         const gchar         *root_path,
                                                                         const gchar         *root_group);
165

166
GLIB_AVAILABLE_IN_ALL
167 168
GSettingsBackend *      g_null_settings_backend_new                     (void);

169
GLIB_AVAILABLE_IN_ALL
170 171
GSettingsBackend *      g_memory_settings_backend_new                   (void);

172 173 174
G_END_DECLS

#endif /* __G_SETTINGS_BACKEND_H__ */