dzl-settings-sandwich: Dazzle Reference Manual

## dzl-settings-sandwich dzl-settings-sandwich |

## Functions

DzlSettingsSandwich * | dzl_settings_sandwich_new ()
GVariant * | dzl_settings_sandwich_get_default_value ()
GVariant * | dzl_settings_sandwich_get_user_value ()
GVariant * | dzl_settings_sandwich_get_value ()
void | dzl_settings_sandwich_set_value ()
gboolean | dzl_settings_sandwich_get_boolean ()
gdouble | dzl_settings_sandwich_get_double ()
gint | dzl_settings_sandwich_get_int ()
gchar * | dzl_settings_sandwich_get_string ()
guint | dzl_settings_sandwich_get_uint ()
void | dzl_settings_sandwich_set_boolean ()
void | dzl_settings_sandwich_set_double ()
void | dzl_settings_sandwich_set_int ()
void | dzl_settings_sandwich_set_string ()
void | dzl_settings_sandwich_set_uint ()
void | dzl_settings_sandwich_append ()
void | dzl_settings_sandwich_bind ()
void | dzl_settings_sandwich_bind_with_mapping ()
void | dzl_settings_sandwich_unbind ()

## Properties

gchar * | path | Read / Write / Construct Only
gchar * | schema-id | Read / Write / Construct Only

## Types and Values

#define | DZL_TYPE_SETTINGS_SANDWICH
| DzlSettingsSandwich

## Object Hierarchy

        GObject
        ╰── DzlSettingsSandwich

## Description

## Functions

### dzl_settings_sandwich_new ()

    DzlSettingsSandwich *
    dzl_settings_sandwich_new (const gchar *schema_id,
                               const gchar *path);

### dzl_settings_sandwich_get_default_value ()

    GVariant *
    dzl_settings_sandwich_get_default_value
                                   (DzlSettingsSandwich *self,
                                    const gchar *key);

### dzl_settings_sandwich_get_user_value ()

    GVariant *
    dzl_settings_sandwich_get_user_value (DzlSettingsSandwich *self,
                                          const gchar *key);

### dzl_settings_sandwich_get_value ()

    GVariant *
    dzl_settings_sandwich_get_value (DzlSettingsSandwich *self,
                                     const gchar *key);

### dzl_settings_sandwich_set_value ()

    void
    dzl_settings_sandwich_set_value (DzlSettingsSandwich *self,
                                     const gchar *key,
                                     GVariant *value);

### dzl_settings_sandwich_get_boolean ()

    gboolean
    dzl_settings_sandwich_get_boolean (DzlSettingsSandwich *self,
                                       const gchar *key);

### dzl_settings_sandwich_get_double ()

    gdouble
    dzl_settings_sandwich_get_double (DzlSettingsSandwich *self,
                                      const gchar *key);

### dzl_settings_sandwich_get_int ()

    gint
    dzl_settings_sandwich_get_int (DzlSettingsSandwich *self,
                                   const gchar *key);

### dzl_settings_sandwich_get_string ()

    gchar *
    dzl_settings_sandwich_get_string (DzlSettingsSandwich *self,
                                      const gchar *key);

### dzl_settings_sandwich_get_uint ()

    guint
    dzl_settings_sandwich_get_uint (DzlSettingsSandwich *self,
                                    const gchar *key);

### dzl_settings_sandwich_set_boolean ()

    void
    dzl_settings_sandwich_set_boolean (DzlSettingsSandwich *self,
                                       const gchar *key,
                                       gboolean val);

### dzl_settings_sandwich_set_double ()

    void
    dzl_settings_sandwich_set_double (DzlSettingsSandwich *self,
                                      const gchar *key,
                                      gdouble val);

### dzl_settings_sandwich_set_int ()

    void
    dzl_settings_sandwich_set_int (DzlSettingsSandwich *self,
                                   const gchar *key,
                                   gint val);

### dzl_settings_sandwich_set_string ()

    void
    dzl_settings_sandwich_set_string (DzlSettingsSandwich *self,
                                      const gchar *key,
                                      const gchar *val);

### dzl_settings_sandwich_set_uint ()

    void
    dzl_settings_sandwich_set_uint (DzlSettingsSandwich *self,
                                    const gchar *key,
                                    guint val);

### dzl_settings_sandwich_append ()

    void
    dzl_settings_sandwich_append (DzlSettingsSandwich *self,
                                  GSettings *settings);

### dzl_settings_sandwich_bind ()

    void
    dzl_settings_sandwich_bind (DzlSettingsSandwich *self,
                                const gchar *key,
                                gpointer object,
                                const gchar *property,
                                GSettingsBindFlags flags);

### dzl_settings_sandwich_bind_with_mapping ()

    void
    dzl_settings_sandwich_bind_with_mapping
                                   (DzlSettingsSandwich *self,
                                    const gchar *key,
                                    gpointer object,
                                    const gchar *property,
                                    GSettingsBindFlags flags,
                                    GSettingsBindGetMapping get_mapping,
                                    GSettingsBindSetMapping set_mapping,
                                    gpointer user_data,
                                    GDestroyNotify destroy);

Creates a new binding similar to `g_settings_bind_with_mapping()` but applying from the resolved value via the settings sandwich.

#### Parameters

self | An DzlSettingsSandwich. |
key | the settings key to bind. |
object (type GObject.Object) | the target object. |
property | the property on `object` to apply. |
flags | flags for the binding. |
get_mapping | the get mapping function. | [scope notified][closure user_data][destroy destroy]
set_mapping | the set mapping function. | [scope notified][closure user_data][destroy destroy]
user_data | user data for `get_mapping` and `set_mapping` . |
destroy | destroy notify for `user_data` . |

### dzl_settings_sandwich_unbind ()

    void
    dzl_settings_sandwich_unbind (DzlSettingsSandwich *self,
                                  const gchar *property);

## Types and Values

### DZL_TYPE_SETTINGS_SANDWICH

    #define DZL_TYPE_SETTINGS_SANDWICH (dzl_settings_sandwich_get_type())

### DzlSettingsSandwich

    typedef struct _DzlSettingsSandwich DzlSettingsSandwich;

## Property Details

### The `“path”` property

      “path”                     gchar *

Settings Path.

Owner: DzlSettingsSandwich

Flags: Read / Write / Construct Only

Default value: NULL

### The `“schema-id”` property

      “schema-id”                gchar *

Schema Id.

Owner: DzlSettingsSandwich

Flags: Read / Write / Construct Only

Default value: NULL