/gpump/trunk

/* c-basic-offset: 2; tab-width: 2; indent-tabs-mode: nil

 * vi: set shiftwidth=2 tabstop=2 expandtab:

 * :indentSize=2:tabSize=2:noTabs=true:

 */

 

#ifndef __H_GPUMP_SETTINGS_DATA__

#define __H_GPUMP_SETTINGS_DATA__

 

/**

 * If this is set, it will use GSettings, otherwise it will use GKeyFile

 * and store store the data in a .ini format conf file in the configuration

 * directory.

 */

#define GPUMP_USE_GSETTINGS 0

 

#include <gtk/gtk.h>

#include <gio/gio.h>

#include <rest/oauth2-proxy.h>

#include <rest/rest-proxy-call.h>

#include <stdlib.h>

#include <string.h>

#include <glib/gi18n.h>

 

#define GPUMP_TYPE_SETTINGS_DATA              (gpump_settings_data_get_type ())

#define GPUMP_SETTINGS_DATA(obj)              (G_TYPE_CHECK_INSTANCE_CAST((obj), GPUMP_TYPE_SETTINGS_DATA, GPumpSettingsData))

#define GPUMP_SETTINGS_DATA_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), GPUMP_TYPE_SETTINGS_DATA, GPumpSettingsDataClass))

#define GPUMP_IS_SETTINGS_DATA(obj)           (G_TYPE_CHECK_INSTANCE_TYPE((obj), GPUMP_TYPE_SETTINGS_DATA))

#define GPUMP_IS_SETTINGS_DATA_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GPUMP_TYPE_SETTINGS_DATA))

#define GPUMP_SETTINGS_DATA_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), GPUMP_TYPE_SETTINGS_DATA, GPumpSettingsDataClass))

 

typedef struct GPumpSettingsData GPumpSettingsData;

typedef struct GPumpSettingsDataClass GPumpSettingsDataClass;

typedef struct GPumpSettingsDataPrivate GPumpSettingsDataPrivate;

 

/* 

 * NAMESPACE: gpump_*

 *

 * CLASS NAMESPACE: gpump_settings_data_*

 */

 

/**

 * A class that holds the settings data.

 *

 * the reason for this is to split data and wiev, simplefying the data modle

 * and what not.

 *

 * This is a singletonian class, to get the instance use the provided

 * gpump_settings_data_get_default () function.

 *

 * Pleace note that this is not thread safe, and should be used with care.

 */

struct GPumpSettingsData {

  GObject parent;

  

  /* Private data is defined in the C file. */

  GPumpSettingsDataPrivate * priv;

};

 

struct GPumpSettingsDataClass {

  GObjectClass parent;

};

 

void g_pump_settings_data_get_type (void) G_GNUC_CONST;

 

/**

 * Create a GPumpSettingsData instance if it does not already exist,

 * if it exists return a pointer to the object.

 *

 * The object's reference count is increased every time this is called, so

 * you need to unref it whet you are done with it.

 */

GPumpSettingsData * gpump_settings_data_get_default ();

 

/**

 * Sets a value in the.

 *

 * valid names are:

 * - ui-x

 * - ui-y

 * - ui-h

 * - ui-w

 * - main-use-dark

 * - main-first-run

 * 

 * if the app is compiled in non-gsettings mode, you will have to use

 * gpump_settings_data_commit ()  whet to commit the changes.

 *

 * @param self the object to perform the operation on.

 * @param name the name of the setting to change.

 * @param data the a GValue that contains the data that should be set.

 *

 * If the data type in the data does not match the expected value type, the

 * value will not be set.

 */

void gpump_settings_data_set (GPumpSettingsData * self,

                              gchar * name,

                              GValue * data);

 

 

/**

 * Gets the data given a name, see gpump_settings_data_set's documentation

 * for more information.

 *

 * @param self the object to get the data from.

 * @param name the name of the value to be returned

 *

 * @returns a GValue containing the value of that was requested.

 */

GValue * gpump_settings_data_get (GPumpSettingsData * self,

                                    gchar * name);

 

/**

 * Commit the the changes to file, only useful when using compiled in

 * non-GSettings mode. In GSettings mode this will do nothing.

 *

 * @param self the object to perform the operation on

 * @param err returns on error if an error happens, should be NULL.

 *

 * @returns TRUE if no error occurred, FALSE otherwise

 *

 * @warning This operation may be relatively I/O intensive, because the file

 * is rewritten.

 */

gboolean gpump_settings_data_commit (GPumpSettingsData * self,

                                     GError ** err);

 

#endif /* #ifndef __H_GPUMP_SETTINGS_DATA__*/