glib/gio/gsettingsbackend.h
Ryan Lortie 84a6e651c2 GSettingsBackend: add read_user_value() API
This will get the 'user' value from the database (ie: the one that the user has
control over).

Provide a default implementation that chains to ->read().  That will work for
all of our internal backends which don't have a concept of layering or
lockdown.

The delayed backend implments "user value" by returning anything that's
in the changeset (incuding an explicit NULL) or chaining up otherwise.

We will use this for g_settings_get_user_value().

https://bugzilla.gnome.org/show_bug.cgi?id=668233
2013-10-28 10:19:49 -07:00

161 lines
7.8 KiB
C

/*
* 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
* version 2 of the licence, or (at your option) any later version.
*
* 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
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*
* 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
#define __GIO_GIO_H_INSIDE__
#include <gio/giotypes.h>
#undef __GIO_GIO_H_INSIDE__
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;
struct _GSettingsBackendClass
{
GObjectClass parent_class;
GVariant * (*read) (GSettingsBackend *backend,
const gchar *key,
const GVariantType *expected_type,
gboolean default_value);
gboolean (*get_writable) (GSettingsBackend *backend,
const gchar *key);
gboolean (*write) (GSettingsBackend *backend,
const gchar *key,
GVariant *value,
gpointer origin_tag);
gboolean (*write_tree) (GSettingsBackend *backend,
GTree *tree,
gpointer origin_tag);
void (*reset) (GSettingsBackend *backend,
const gchar *key,
gpointer origin_tag);
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);
GVariant * (*read_user_value) (GSettingsBackend *backend,
const gchar *key,
const GVariantType *expected_type);
gpointer padding[23];
};
struct _GSettingsBackend
{
GObject parent_instance;
/*< private >*/
GSettingsBackendPrivate *priv;
};
GLIB_AVAILABLE_IN_ALL
GType g_settings_backend_get_type (void);
GLIB_AVAILABLE_IN_ALL
void g_settings_backend_changed (GSettingsBackend *backend,
const gchar *key,
gpointer origin_tag);
GLIB_AVAILABLE_IN_ALL
void g_settings_backend_path_changed (GSettingsBackend *backend,
const gchar *path,
gpointer origin_tag);
GLIB_AVAILABLE_IN_ALL
void g_settings_backend_flatten_tree (GTree *tree,
gchar **path,
const gchar ***keys,
GVariant ***values);
GLIB_AVAILABLE_IN_ALL
void g_settings_backend_keys_changed (GSettingsBackend *backend,
const gchar *path,
gchar const * const *items,
gpointer origin_tag);
GLIB_AVAILABLE_IN_ALL
void g_settings_backend_path_writable_changed (GSettingsBackend *backend,
const gchar *path);
GLIB_AVAILABLE_IN_ALL
void g_settings_backend_writable_changed (GSettingsBackend *backend,
const gchar *key);
GLIB_AVAILABLE_IN_ALL
void g_settings_backend_changed_tree (GSettingsBackend *backend,
GTree *tree,
gpointer origin_tag);
GLIB_AVAILABLE_IN_ALL
GSettingsBackend * g_settings_backend_get_default (void);
GLIB_AVAILABLE_IN_ALL
GSettingsBackend * g_keyfile_settings_backend_new (const gchar *filename,
const gchar *root_path,
const gchar *root_group);
GLIB_AVAILABLE_IN_ALL
GSettingsBackend * g_null_settings_backend_new (void);
GLIB_AVAILABLE_IN_ALL
GSettingsBackend * g_memory_settings_backend_new (void);
G_END_DECLS
#endif /* __G_SETTINGS_BACKEND_H__ */