gok-settings-dialog

## gok-settings-dialog gok-settings-dialog |

## Synopsis

    gboolean            gok_settingsdialog_open             (gboolean bShow);
    void                gok_settingsdialog_close            (void);
    gboolean            gok_settingsdialog_show             (void);
    void                gok_settingsdialog_hide             (void);
    void                on_button_try                       (GtkButton *button,
                                                             gpointer user_data);
    void                on_button_revert                    (GtkButton *button,
                                                             gpointer user_data);
    void                on_button_ok                        (GtkButton *button,
                                                             gpointer user_data);
    void                on_button_cancel                    (GtkButton *button,
                                                             gpointer user_data);
    void                on_button_help                      (GtkButton *button,
                                                             gpointer user_data);
    void                gok_settingsdialog_refresh          (void);
    void                gok_settingsdialog_backup_settings  (void);
    GtkWidget*          gok_settingsdialog_get_window       (void);

## Description

## Details

### gok_settingsdialog_open ()

    gboolean            gok_settingsdialog_open             (gboolean bShow);

Creates the GOK settings dialog.

`bShow`: If TRUE the settings dialog will be shown. If FALSE the dialog will be created but not shown.

`bShow` : |
Returns : | TRUE if the settings dialog could be created, FALSE if not.

### gok_settingsdialog_close ()

    void                gok_settingsdialog_close            (void);

Destroys the GOK settings dialog.

Returns : | void

### gok_settingsdialog_show ()

    gboolean            gok_settingsdialog_show             (void);

Displays the GOK settings dialog.

Returns : | TRUE if the settings dialog was shown, FALSE if not.

### gok_settingsdialog_hide ()

    void                gok_settingsdialog_hide             (void);

Hides the GOK settings dialog.

### on_button_try ()

    void                on_button_try                       (GtkButton *button,
                                                             gpointer user_data);

The TRY button has been clicked. Apply any changes from the settings but don't hide the dialog

`button` : |
`user_data` : | Any user data associated with the button.

### on_button_revert ()

    void                on_button_revert                    (GtkButton *button,
                                                             gpointer user_data);

The REVERT button has been clicked. Returns the settings to the way they were and update the keyboard.

`button` : |
`user_data` : | Any user data associated with the button.

### on_button_ok ()

    void                on_button_ok                        (GtkButton *button,
                                                             gpointer user_data);

The OK button has been clicked. Apply any changes from the settings and hide the settings dialog.

`button` : |
`user_data` : | Any user data associated with the button.

### on_button_cancel ()

    void                on_button_cancel                    (GtkButton *button,
                                                             gpointer user_data);

The CANCEL button has been clicked. Return settings to the way they were and update the keyboard and hide the settings dialog.

`button` : |
`user_data` : | Any user data associated with the button.

### on_button_help ()

    void                on_button_help                      (GtkButton *button,
                                                             gpointer user_data);

The HELP button has been clicked.

`button` : |
`user_data` : | Any user data associated with the button.

### gok_settingsdialog_refresh ()

    void                gok_settingsdialog_refresh          (void);

Refreshes the dialog controls. This should be called after the user has resized the keyboard (which causes the key size to change) or if the gok data has changed.

### gok_settingsdialog_backup_settings ()

    void                gok_settingsdialog_backup_settings  (void);

Copies all the member settings to backup.

### gok_settingsdialog_get_window ()

    GtkWidget*          gok_settingsdialog_get_window       (void);

Returns : | A pointer to the settings dialog window.