GnuCash  4.11-137-g155922540d+
gnc-gsettings.h
Go to the documentation of this file.
1 /********************************************************************\
2  * gnc-gsettings.h -- utility functions for storing/retrieving *
3  * data in the GSettings database for GnuCash *
4  * Copyright (C) 2013 Geert Janssens <geert@kobaltwit.be> *
5  * *
6  * This program is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU General Public License as *
8  * published by the Free Software Foundation; either version 2 of *
9  * the License, or (at your option) any later version. *
10  * *
11  * This program is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14  * GNU General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU General Public License*
17  * along with this program; if not, contact: *
18  * *
19  * Free Software Foundation Voice: +1-617-542-5942 *
20  * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
21  * Boston, MA 02110-1301, USA gnu@gnu.org *
22  * *
23 \********************************************************************/
24 
50 #ifndef GNC_GSETTINGS_H
51 #define GNC_GSETTINGS_H
52 
53 #include <glib.h>
54 
71 gchar *gnc_gsettings_normalize_schema_name (const gchar *name);
72 
77 const gchar *gnc_gsettings_get_prefix (void);
78 
79 
82 void gnc_gsettings_block_all (void);
83 
84 
87 void gnc_gsettings_unblock_all (void);
88 
89 
114 gulong gnc_gsettings_register_cb (const char *schema,
115  const gchar *key,
116  gpointer func,
117  gpointer user_data);
118 
119 
137 void gnc_gsettings_remove_cb_by_func (const gchar *schema,
138  const gchar *key,
139  gpointer func,
140  gpointer user_data);
141 
142 
154 void gnc_gsettings_remove_cb_by_id (const gchar *schema,
155  guint id);
156 
157 
172 guint gnc_gsettings_register_any_cb (const gchar *schema,
173  gpointer func,
174  gpointer user_data);
175 
176 
197 void gnc_gsettings_remove_any_cb_by_func (const gchar *schema,
198  gpointer func,
199  gpointer user_data);
200 
201 
220 void gnc_gsettings_bind (const gchar *schema,
221  /*@ null @*/ const gchar *key,
222  gpointer object,
223  const gchar *property);
224 
225 
251 gboolean gnc_gsettings_get_bool (const gchar *schema,
252  /*@ null @*/ const gchar *key);
253 
277 gint gnc_gsettings_get_int (const gchar *schema,
278  const gchar *key);
279 
303 gdouble gnc_gsettings_get_float (const gchar *schema,
304  const gchar *key);
305 
330 gchar *gnc_gsettings_get_string (const gchar *schema,
331  const gchar *key);
332 
356 gint gnc_gsettings_get_enum (const gchar *schema,
357  const gchar *key);
358 
386 GVariant *gnc_gsettings_get_value (const gchar *schema,
387  const gchar *key);
388 
417 gboolean gnc_gsettings_set_bool (const gchar *schema,
418  const gchar *key,
419  gboolean value);
420 
442 gboolean gnc_gsettings_set_int (const gchar *schema,
443  const gchar *key,
444  gint value);
445 
467 gboolean gnc_gsettings_set_float (const gchar *schema,
468  const gchar *key,
469  gdouble value);
470 
471 
495 gboolean gnc_gsettings_set_string (const gchar *schema,
496  const gchar *key,
497  const gchar *value);
498 
520 gboolean gnc_gsettings_set_enum (const gchar *schema,
521  const gchar *key,
522  gint value);
523 
548 gboolean gnc_gsettings_set_value (const gchar *schema,
549  const gchar *key,
550  GVariant *value);
551 
571 void gnc_gsettings_reset (const gchar *schema,
572  const gchar *key);
573 
590 void gnc_gsettings_reset_schema (const gchar *schema);
591 
597 void gnc_gsettings_load_backend (void);
598 
607 
608 #endif /* GNC_GSETTINGS_H */
609 
gchar * gnc_gsettings_normalize_schema_name(const gchar *name)
Convert a partial schema name into a complete gsettings schema name.
gboolean gnc_gsettings_set_int(const gchar *schema, const gchar *key, gint value)
Store an integer value into GSettings.
gboolean gnc_gsettings_set_float(const gchar *schema, const gchar *key, gdouble value)
Store a float value into GSettings.
gint gnc_gsettings_get_int(const gchar *schema, const gchar *key)
Get an integer value from GSettings.
void gnc_gsettings_bind(const gchar *schema, const gchar *key, gpointer object, const gchar *property)
Bind a setting to a g_object property.
void gnc_gsettings_remove_any_cb_by_func(const gchar *schema, gpointer func, gpointer user_data)
Remove a function that was registered for a callback when any key in the given settings schema change...
gboolean gnc_gsettings_set_enum(const gchar *schema, const gchar *key, gint value)
Store an enum value into GSettings.
GVariant * gnc_gsettings_get_value(const gchar *schema, const gchar *key)
Get an arbitrary combination of values from GSettings.
guint gnc_gsettings_register_any_cb(const gchar *schema, gpointer func, gpointer user_data)
Register a callback for when any key in the settings schema is changed.
void gnc_gsettings_unblock_all(void)
UnBlock all prefs callbacks, used while preference dialog is loaded.
void gnc_gsettings_reset_schema(const gchar *schema)
Reset all keys in a schema to their default values in GSettings.
gdouble gnc_gsettings_get_float(const gchar *schema, const gchar *key)
Get an float value from GSettings.
void gnc_gsettings_reset(const gchar *schema, const gchar *key)
Reset a key to its default value in GSettings.
gchar * gnc_gsettings_get_string(const gchar *schema, const gchar *key)
Get a string value from GSettings.
gint gnc_gsettings_get_enum(const gchar *schema, const gchar *key)
Get an enum value from GSettings.
gboolean gnc_gsettings_set_bool(const gchar *schema, const gchar *key, gboolean value)
Store a boolean value into GSettings.
void gnc_gsettings_load_backend(void)
Configure gsettings as the backend for the gnucash preferences api.
void gnc_gsettings_version_upgrade(void)
Check whether we need to adjust the user settings to a newer version.
void gnc_gsettings_block_all(void)
Block all prefs callbacks, used while preference dialog is loaded.
gboolean gnc_gsettings_get_bool(const gchar *schema, const gchar *key)
Get a boolean value from GSettings.
const gchar * gnc_gsettings_get_prefix(void)
Get the default gsettings schema prefix.
void gnc_gsettings_remove_cb_by_id(const gchar *schema, guint id)
Remove a function that was registered for a callback when a specific key in the settings schema chang...
gboolean gnc_gsettings_set_value(const gchar *schema, const gchar *key, GVariant *value)
Store an arbitrary combination of values into GSettings.
gulong gnc_gsettings_register_cb(const char *schema, const gchar *key, gpointer func, gpointer user_data)
Register a callback for when a specific key in the settings schema is changed.
gboolean gnc_gsettings_set_string(const gchar *schema, const gchar *key, const gchar *value)
Store a string into GSettings.
void gnc_gsettings_remove_cb_by_func(const gchar *schema, const gchar *key, gpointer func, gpointer user_data)
Remove a function that was registered for a callback when a specific key in the settings schema chang...