gnc-gsettings.h

Go to the documentation of this file.

/********************************************************************\
 * gnc-gsettings.h -- utility functions for storing/retrieving      *
 *              data in the GSettings database for GnuCash          *
 * Copyright (C) 2013 Geert Janssens <[email protected]>           *
 *                                                                  *
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program 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 General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       [email protected]                   *
 *                                                                  *
\********************************************************************/

#ifndef GNC_GSETTINGS_H
#define GNC_GSETTINGS_H

#include <gio/gio.h>

#define GSET_SCHEMA_PREFIX            "org.gnucash"

gchar *gnc_gsettings_normalize_schema_name (const gchar *name);


void gnc_gsettings_set_prefix (const gchar *prefix);

const gchar *gnc_gsettings_get_prefix (void);


gulong gnc_gsettings_register_cb (const char *schema,
                                  const gchar *key,
                                  gpointer func,
                                  gpointer user_data);


void gnc_gsettings_remove_cb_by_func (const gchar *schema,
                                      const gchar *key,
                                      gpointer func,
                                      gpointer user_data);


void gnc_gsettings_remove_cb_by_id (const gchar *schema,
                                    guint id);


guint gnc_gsettings_register_any_cb (const gchar *schema,
                                     gpointer func,
                                     gpointer user_data);


void gnc_gsettings_remove_any_cb_by_func (const gchar *schema,
        gpointer func,
        gpointer user_data);


void gnc_gsettings_bind (const gchar *schema,
                         /*@ null @*/ const gchar *key,
                         gpointer object,
                         const gchar *property);


gboolean gnc_gsettings_get_bool (const gchar *schema,
                                 /*@ null @*/ const gchar *key);

gint gnc_gsettings_get_int (const gchar *schema,
                            const gchar *key);

gdouble gnc_gsettings_get_float (const gchar *schema,
                                 const gchar *key);

gchar *gnc_gsettings_get_string (const gchar *schema,
                                 const gchar *key);

gint gnc_gsettings_get_enum (const gchar *schema,
                             const gchar *key);

GVariant *gnc_gsettings_get_value (const gchar *schema,
                                   const gchar *key);

gboolean gnc_gsettings_set_bool (const gchar *schema,
                                 const gchar *key,
                                 gboolean value);

gboolean gnc_gsettings_set_int (const gchar *schema,
                                const gchar *key,
                                gint value);

gboolean gnc_gsettings_set_float (const gchar *schema,
                                  const gchar *key,
                                  gdouble value);


gboolean gnc_gsettings_set_string (const gchar *schema,
                                   const gchar *key,
                                   const gchar *value);

gboolean gnc_gsettings_set_enum (const gchar *schema,
                                 const gchar *key,
                                 gint value);

gboolean gnc_gsettings_set_value (const gchar *schema,
                                  const gchar *key,
                                  GVariant *value);

void gnc_gsettings_reset (const gchar *schema,
                          const gchar *key);

void gnc_gsettings_reset_schema (const gchar *schema);

void gnc_gsettings_load_backend (void);


/* Attempt to migrate preferences from gconf files
    to gsettings if not already done so */
void gnc_gsettings_migrate_from_gconf (void);

#endif /* GNC_GSETTINGS_H */