DzlPreferences: Dazzle Reference Manual

## DzlPreferences DzlPreferences |

## Functions

void | dzl_preferences_add_page ()
void | dzl_preferences_add_group ()
void | dzl_preferences_add_list_group ()
guint | dzl_preferences_add_radio ()
guint | dzl_preferences_add_switch ()
guint | dzl_preferences_add_spin_button ()
guint | dzl_preferences_add_custom ()
guint | dzl_preferences_add_font_button ()
guint | dzl_preferences_add_file_chooser ()
gboolean | dzl_preferences_remove_id ()
void | dzl_preferences_set_page ()
GtkWidget * | dzl_preferences_get_widget ()
guint | dzl_preferences_add_table_row ()

## Types and Values

#define | DZL_TYPE_PREFERENCES
struct | DzlPreferencesInterface
| DzlPreferences

## Object Hierarchy

        GInterface
        ╰── DzlPreferences

## Prerequisites

DzlPreferences requires GObject.

## Known Implementations

DzlPreferences is implemented by DzlPreferencesView.

## Description

## Functions

### dzl_preferences_add_page ()

    void
    dzl_preferences_add_page (DzlPreferences *self,
                              const gchar *page_name,
                              const gchar *title,
                              gint priority);

### dzl_preferences_add_group ()

    void
    dzl_preferences_add_group (DzlPreferences *self,
                               const gchar *page_name,
                               const gchar *group_name,
                               const gchar *title,
                               gint priority);

### dzl_preferences_add_list_group ()

    void
    dzl_preferences_add_list_group (DzlPreferences *self,
                                    const gchar *page_name,
                                    const gchar *group_name,
                                    const gchar *title,
                                    GtkSelectionMode mode,
                                    gint priority);

### dzl_preferences_add_radio ()

    guint
    dzl_preferences_add_radio (DzlPreferences *self,
                               const gchar *page_name,
                               const gchar *group_name,
                               const gchar *schema_id,
                               const gchar *key,
                               const gchar *path,
                               const gchar *variant_string,
                               const gchar *title,
                               const gchar *subtitle,
                               const gchar *keywords,
                               gint priority);

#### Parameters

path | An optional path. | [nullable]
variant_string | An optional gvariant string. | [nullable]
title | An optional title. | [nullable]
subtitle | An optional subtitle. | [nullable]
keywords | Optional keywords for search. | [nullable]

### dzl_preferences_add_switch ()

    guint
    dzl_preferences_add_switch (DzlPreferences *self,
                                const gchar *page_name,
                                const gchar *group_name,
                                const gchar *schema_id,
                                const gchar *key,
                                const gchar *path,
                                const gchar *variant_string,
                                const gchar *title,
                                const gchar *subtitle,
                                const gchar *keywords,
                                gint priority);

#### Parameters

path | An optional path. | [nullable]
variant_string | An optional gvariant string. | [nullable]
title | An optional title. | [nullable]
subtitle | An optional subtitle. | [nullable]
keywords | Optional keywords for search. | [nullable]

### dzl_preferences_add_spin_button ()

    guint
    dzl_preferences_add_spin_button (DzlPreferences *self,
                                     const gchar *page_name,
                                     const gchar *group_name,
                                     const gchar *schema_id,
                                     const gchar *key,
                                     const gchar *path,
                                     const gchar *title,
                                     const gchar *subtitle,
                                     const gchar *keywords,
                                     gint priority);

### dzl_preferences_add_custom ()

    guint
    dzl_preferences_add_custom (DzlPreferences *self,
                                const gchar *page_name,
                                const gchar *group_name,
                                GtkWidget *widget,
                                const gchar *keywords,
                                gint priority);

#### Parameters

keywords | Optional keywords for search. | [nullable]

### dzl_preferences_add_font_button ()

    guint
    dzl_preferences_add_font_button (DzlPreferences *self,
                                     const gchar *page_name,
                                     const gchar *group_name,
                                     const gchar *schema_id,
                                     const gchar *key,
                                     const gchar *title,
                                     const gchar *keywords,
                                     gint priority);

### dzl_preferences_add_file_chooser ()

    guint
    dzl_preferences_add_file_chooser (DzlPreferences *self,
                                      const gchar *page_name,
                                      const gchar *group_name,
                                      const gchar *schema_id,
                                      const gchar *key,
                                      const gchar *path,
                                      const gchar *title,
                                      const gchar *subtitle,
                                      GtkFileChooserAction action,
                                      const gchar *keywords,
                                      gint priority);

### dzl_preferences_remove_id ()

    gboolean
    dzl_preferences_remove_id (DzlPreferences *self,
                               guint widget_id);

### dzl_preferences_set_page ()

    void
    dzl_preferences_set_page (DzlPreferences *self,
                              const gchar *page_name,
                              GHashTable *map);

### dzl_preferences_get_widget ()

    GtkWidget *
    dzl_preferences_get_widget (DzlPreferences *self,
                                guint widget_id);

#### Returns

A GtkWidget or `NULL`.

[transfer none][nullable]

### dzl_preferences_add_table_row ()

    guint
    dzl_preferences_add_table_row (DzlPreferences *self,
                                   const gchar *page_name,
                                   const gchar *group_name,
                                   GtkWidget *first_widget,
                                   ...);

## Types and Values

### DZL_TYPE_PREFERENCES

    #define DZL_TYPE_PREFERENCES (dzl_preferences_get_type())

### struct DzlPreferencesInterface

    struct DzlPreferencesInterface {
      GTypeInterface parent_interface;

      void        (*set_page)                   (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 GHashTable           *map);
      void        (*add_page)                   (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *title,
                                                 gint                  priority);
      void        (*add_group)                  (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 const gchar          *title,
                                                 gint                  priority);
      void        (*add_list_group)             (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 const gchar          *title,
                                                 GtkSelectionMode      mode,
                                                 gint                  priority);
      guint       (*add_radio)                  (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 const gchar          *schema_id,
                                                 const gchar          *key,
                                                 const gchar          *path,
                                                 const gchar          *variant_string,
                                                 const gchar          *title,
                                                 const gchar          *subtitle,
                                                 const gchar          *keywords,
                                                 gint                  priority);
      guint       (*add_font_button)            (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 const gchar          *schema_id,
                                                 const gchar          *key,
                                                 const gchar          *title,
                                                 const gchar          *keywords,
                                                 gint                  priority);
      guint       (*add_switch)                 (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 const gchar          *schema_id,
                                                 const gchar          *key,
                                                 const gchar          *path,
                                                 const gchar          *variant_string,
                                                 const gchar          *title,
                                                 const gchar          *subtitle,
                                                 const gchar          *keywords,
                                                 gint                  priority);
      guint       (*add_spin_button)            (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 const gchar          *schema_id,
                                                 const gchar          *key,
                                                 const gchar          *path,
                                                 const gchar          *title,
                                                 const gchar          *subtitle,
                                                 const gchar          *keywords,
                                                 gint                  priority);
      guint      (*add_file_chooser)            (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 const gchar          *schema_id,
                                                 const gchar          *key,
                                                 const gchar          *path,
                                                 const gchar          *title,
                                                 const gchar          *subtitle,
                                                 GtkFileChooserAction  action,
                                                 const gchar          *keywords,
                                                 gint                  priority);
      guint      (*add_custom)                  (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 GtkWidget            *widget,
                                                 const gchar          *keywords,
                                                 gint                  priority);
      gboolean   (*remove_id)                   (DzlPreferences       *self,
                                                 guint                 widget_id);
      GtkWidget *(*get_widget)                  (DzlPreferences       *self,
                                                 guint                 widget_id);
      guint      (*add_table_row_va)            (DzlPreferences       *self,
                                                 const gchar          *page_name,
                                                 const gchar          *group_name,
                                                 GtkWidget            *first_widget,
                                                 va_list               args);
    };

### DzlPreferences

    typedef struct _DzlPreferences DzlPreferences;