Panel Applet MateConf Utilities

- - -

Panel Applet MateConf Utilities

Panel Applet MateConf Utilities — Utility methods for manipulating per-applet MateConf preferences.

Synopsis

-#include <mate-panel-applet-mateconf.h>
-
-gchar *             mate_panel_applet_mateconf_get_full_key     (MatePanelApplet *applet,
-                                                         const gchar *key);
-gboolean            mate_panel_applet_mateconf_get_bool         (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);
-gint                mate_panel_applet_mateconf_get_int          (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);
-gchar *             mate_panel_applet_mateconf_get_string       (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);
-gdouble             mate_panel_applet_mateconf_get_float        (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);
-GSList *            mate_panel_applet_mateconf_get_list         (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         MateConfValueType list_type,
-                                                         GError **opt_error);
-MateConfValue *        mate_panel_applet_mateconf_get_value        (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);
-void                mate_panel_applet_mateconf_set_bool         (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         gboolean the_bool,
-                                                         GError **opt_error);
-void                mate_panel_applet_mateconf_set_int          (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         gint the_int,
-                                                         GError **opt_error);
-void                mate_panel_applet_mateconf_set_string       (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         const gchar *the_string,
-                                                         GError **opt_error);
-void                mate_panel_applet_mateconf_set_float        (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         gdouble the_float,
-                                                         GError **opt_error);
-void                mate_panel_applet_mateconf_set_list         (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         MateConfValueType list_type,
-                                                         GSList *list,
-                                                         GError **opt_error);
-void                mate_panel_applet_mateconf_set_value        (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         MateConfValue *value,
-                                                         GError **opt_error);
-

Description

-Applets typically define a set of preferences using a schemas -file and mate_panel_applet_add_preferences(). Such preferences apply -only to an individual applet instance. For example, you may add -two clock applets to the panel and configure them differently. -

-In order for the preferences to only apply to a single applet, -each applet must have a seperate MateConf key for each of these -preferences. The methods described below provide convient wrappers -around the usual MateConfClient functions and operate on these -per-applet keys. -

Details

mate_panel_applet_mateconf_get_full_key ()

gchar *             mate_panel_applet_mateconf_get_full_key     (MatePanelApplet *applet,
-                                                         const gchar *key);

-Access the full path for an individual per-applet MateConf key. Using -the returned path you may directly modify the preference using -the usual MateConf functions without using any of the convenience -wrappers described below. -

-- - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
Returns :	The full MateConf key - free using `g_free()`. -

mate_panel_applet_mateconf_get_bool ()

gboolean            mate_panel_applet_mateconf_get_bool         (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_get_bool() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_get_bool() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`opt_error` :	Optional GError**. -
Returns :	The bool value of the key. -

mate_panel_applet_mateconf_get_int ()

gint                mate_panel_applet_mateconf_get_int          (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_get_int() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_get_int() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`opt_error` :	Optional GError**. -
Returns :	The integer value of the key. -

mate_panel_applet_mateconf_get_string ()

gchar *             mate_panel_applet_mateconf_get_string       (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_get_string() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_get_string() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`opt_error` :	Optional GError**. -
Returns :	The string value of the key, or `NULL` if unset. -

mate_panel_applet_mateconf_get_float ()

gdouble             mate_panel_applet_mateconf_get_float        (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_get_float() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_get_float() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`opt_error` :	Optional GError**. -
Returns :	The floating point value of the key. -

mate_panel_applet_mateconf_get_list ()

GSList *            mate_panel_applet_mateconf_get_list         (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         MateConfValueType list_type,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_get_list() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_get_list() -returns. -

-- - - - - - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`list_type` :	The MateConf value type of the list elements. -
`opt_error` :	Optional GError**. -
Returns :	The list of values set for the key. -

mate_panel_applet_mateconf_get_value ()

MateConfValue *        mate_panel_applet_mateconf_get_value        (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_get_value() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_get_value() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`opt_error` :	Optional GError**. -
Returns :	The MateConf value set for the key. -

mate_panel_applet_mateconf_set_bool ()

void                mate_panel_applet_mateconf_set_bool         (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         gboolean the_bool,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_set_bool() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_set_bool() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`the_bool` :	The boolean value to set the key with. -
`opt_error` :	Optional GError**. -

mate_panel_applet_mateconf_set_int ()

void                mate_panel_applet_mateconf_set_int          (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         gint the_int,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_set_int() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_set_int() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`the_int` :	The integer value to set the key with. -
`opt_error` :	Optional GError**. -

mate_panel_applet_mateconf_set_string ()

void                mate_panel_applet_mateconf_set_string       (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         const gchar *the_string,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_set_string() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_set_string() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`the_string` :	The string value to set the key with. -
`opt_error` :	Optional GError**. -

mate_panel_applet_mateconf_set_float ()

void                mate_panel_applet_mateconf_set_float        (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         gdouble the_float,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_set_float() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_set_float() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`the_float` :	The floating point value to set the key with. -
`opt_error` :	Optional GError**. -

mate_panel_applet_mateconf_set_list ()

void                mate_panel_applet_mateconf_set_list         (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         MateConfValueType list_type,
-                                                         GSList *list,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_set_list() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_set_list() -returns. -

-- - - - - - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`list_type` :	The MateConf value type of the list items. -
`list` :	The list of values to set the key with. -
`opt_error` :	Optional GError**. -

mate_panel_applet_mateconf_set_value ()

void                mate_panel_applet_mateconf_set_value        (MatePanelApplet *applet,
-                                                         const gchar *key,
-                                                         MateConfValue *value,
-                                                         GError **opt_error);

-Convience wrapper for mateconf_client_set_value() which operates -on the individual per-applet key. -

-If you pass NULL for opt_error, this function will print -a warning message from any GError which mateconf_client_set_value() -returns. -

-- - - - - - - - - - - - - - - - - - -

`applet` :	The MatePanelApplet. -
`key` :	The key name of the preference. -
`value` :	The MateConf value to set the key with. -
`opt_error` :	Optional GError**. -

			Panel Applet Library Reference Manual
-Top - \| - Description -