GConf Bridge

GConf Bridge

Synopsis

                    GConfBridge;
void                gconf_bridge_install_default_error_handler
                                                        (void);
GConfBridge *       gconf_bridge_get                    (void);
GConfClient *       gconf_bridge_get_client             (GConfBridge *bridge);
guint               gconf_bridge_bind_property_full     (GConfBridge *bridge,
                                                         const gchar *key,
                                                         GObject *object,
                                                         const gchar *prop,
                                                         gboolean delayed_sync);
#define             gconf_bridge_bind_property          (bridge,
                                                         key,
                                                         object,
                                                         prop)
#define             gconf_bridge_bind_property_delayed  (bridge,
                                                         key,
                                                         object,
                                                         prop)
guint               gconf_bridge_bind_window            (GConfBridge *bridge,
                                                         const gchar *key_prefix,
                                                         GtkWindow *window,
                                                         gboolean bind_size,
                                                         gboolean bind_pos);
#define             gconf_bridge_bind_window_size       (bridge,
                                                         key_prefix,
                                                         window)
#define             gconf_bridge_bind_window_pos        (bridge,
                                                         key_prefix,
                                                         window)
guint               gconf_bridge_bind_string_list_store (GConfBridge *bridge,
                                                         const gchar *key,
                                                         GtkListStore *list_store);
void                gconf_bridge_unbind                 (GConfBridge *bridge,
                                                         guint binding_id);

Description

Details

GConfBridge

typedef struct _GConfBridge GConfBridge;


gconf_bridge_install_default_error_handler ()

void                gconf_bridge_install_default_error_handler
                                                        (void);

Sets up the default error handler. Any unhandled GConf errors will automatically be handled by presenting the user an error dialog.


gconf_bridge_get ()

GConfBridge *       gconf_bridge_get                    (void);

Returns the GConfBridge. This is a singleton object.

Returns :

The GConfBridge.

gconf_bridge_get_client ()

GConfClient *       gconf_bridge_get_client             (GConfBridge *bridge);

Returns the GConfClient used by bridge. This is the same GConfClient as returned by gconf_client_get_default().

bridge :

A GConfBridge

Returns :

A GConfClient.

gconf_bridge_bind_property_full ()

guint               gconf_bridge_bind_property_full     (GConfBridge *bridge,
                                                         const gchar *key,
                                                         GObject *object,
                                                         const gchar *prop,
                                                         gboolean delayed_sync);

Binds key to prop, causing them to have the same value at all times.

The types of key and prop should be compatible. Floats and doubles, and ints, uints, longs, unlongs, int64s, uint64s, chars, uchars and enums can be matched up. Booleans and strings can only be matched to their respective types.

On calling this function the current value of key will be set to prop.

bridge :

A GConfBridge

key :

A GConf key to be bound

object :

A GObject

prop :

The property of object to be bound

delayed_sync :

TRUE if there should be a delay between property changes and syncs to GConf. Set to TRUE when binding to a rapidly-changing property, for example the "value" property on a GtkAdjustment.

Returns :

The ID of the new binding.

gconf_bridge_bind_property()

#define             gconf_bridge_bind_property(bridge, key, object, prop)

Binds key to prop without delays, causing them to have the same value at all times. See gconf_bridge_bind_property_full for more details.

bridge :

A GConfBridge

key :

A GConf key to be bound

object :

A GObject

prop :

The property of object to be bound

gconf_bridge_bind_property_delayed()

#define             gconf_bridge_bind_property_delayed(bridge, key, object, prop)

Binds key to prop with a delay, causing them to have the same value at all times. See gconf_bridge_bind_property_full for more details.

bridge :

A GConfBridge

key :

A GConf key to be bound

object :

A GObject

prop :

The property of object to be bound

gconf_bridge_bind_window ()

guint               gconf_bridge_bind_window            (GConfBridge *bridge,
                                                         const gchar *key_prefix,
                                                         GtkWindow *window,
                                                         gboolean bind_size,
                                                         gboolean bind_pos);

On calling this function window will be resized to the values specified by "key_prefix_width" and "key_prefix_height" and maximixed if "key_prefix_maximized is TRUE if bind_size is TRUE, and moved to the values specified by "key_prefix_x" and "key_prefix_y" if bind_pos is TRUE. The respective GConf values will be updated when the window is resized and/or moved.

bridge :

A GConfBridge

key_prefix :

The prefix of the GConf keys

window :

A GtkWindow

bind_size :

TRUE to bind the size of window

bind_pos :

TRUE to bind the position of window

Returns :

The ID of the new binding.

gconf_bridge_bind_window_size()

#define             gconf_bridge_bind_window_size(bridge, key_prefix, window)

On calling this function window will be resized to the values specified by "key_prefix_width" and "key_prefix_height". The respective GConf values will be updated when the window is resized. See gconf_bridge_bind_window for more details.

bridge :

A GConfBridge

key_prefix :

The prefix of the GConf keys

window :

A GtkWindow

gconf_bridge_bind_window_pos()

#define             gconf_bridge_bind_window_pos(bridge, key_prefix, window)

On calling this function window will be moved to the values specified by "key_prefix_x" and "key_prefix_y". The respective GConf values will be updated when the window is moved. See gconf_bridge_bind_window for more details.

bridge :

A GConfBridge

key_prefix :

The prefix of the GConf keys

window :

A GtkWindow

gconf_bridge_bind_string_list_store ()

guint               gconf_bridge_bind_string_list_store (GConfBridge *bridge,
                                                         const gchar *key,
                                                         GtkListStore *list_store);

On calling this function single string column GtkListStore list_store will be kept synchronized with the GConf string list value pointed to by key. On calling this function list_store will be populated with the strings specified by the value of key.

bridge :

A GConfBridge

key :

A GConf key to be bound

list_store :

A GtkListStore

Returns :

The ID of the new binding.

gconf_bridge_unbind ()

void                gconf_bridge_unbind                 (GConfBridge *bridge,
                                                         guint binding_id);

Removes the binding with ID binding_id.

bridge :

A GConfBridge

binding_id :

The ID of the binding to be removed