gok-page-actions

## gok-page-actions gok-page-actions |

## Synopsis

    gboolean            gok_page_actions_initialize         (void);
    void                gok_page_actions_refresh            (void);
    gboolean            gok_page_actions_apply              (void);
    gboolean            gok_page_actions_revert             (void);
    void                gok_page_actions_backup             (void);
    void                gok_page_actions_toggle_type_switch (gboolean Pressed);
    void                gok_page_actions_button_clicked_new (void);
    void                gok_page_actions_button_clicked_delete
                                                            (void);
    void                gok_page_actions_button_clicked_change_name
                                                            (void);
    void                gok_page_actions_action_changed     (GtkComboBox *combo);
    void                gok_page_actions_enable_switch_controls
                                                            (gboolean bTrueFalse);
    void                gok_page_actions_enable_radios_type (gboolean bTrueFalse);
    void                gok_page_actions_fill_combo_action_names
                                                            (void);
    gint                gok_page_actions_get_radio_number   (GtkRadioButton *pRadioButtonGiven);
    void                gok_page_actions_update_controls    (GokAction *pAction);
    void                gok_page_actions_set_number         (gint NumberSwitch);
    void                gok_page_actions_set_state          (gint State);
    void                gok_page_actions_set_rate           (gint Rate);

## Description

## Details

### gok_page_actions_initialize ()

    gboolean            gok_page_actions_initialize         (void);

Initializes this page of the gok settings dialog. This must be called prior to any calls on this page.

Returns : | TRUE if the page was properly initialized, FALSE if not.

### gok_page_actions_refresh ()

    void                gok_page_actions_refresh            (void);

Refreshes the controls on the this page from the gok data.

### gok_page_actions_apply ()

    gboolean            gok_page_actions_apply              (void);

Updates the gok data with values from the controls. Unfinished.

Returns : | TRUE if any of the data members have changed, FALSE if not.

### gok_page_actions_revert ()

    gboolean            gok_page_actions_revert             (void);

Revert to the backup settings for this page.

Returns : | TRUE if any of the settings have changed, FALSE if they are all still the same.

### gok_page_actions_backup ()

    void                gok_page_actions_backup             (void);

Copies all the member settings to backup.

### gok_page_actions_toggle_type_switch ()

    void                gok_page_actions_toggle_type_switch (gboolean Pressed);

The radio button for the type 'switch' has been toggled. Hide or show the controls for the switch actions.

`Pressed` : | State of the toggle button.

### gok_page_actions_button_clicked_new ()

    void                gok_page_actions_button_clicked_new (void);

The button "new action" has been clicked so add a new action.

### gok_page_actions_button_clicked_delete ()

    void                gok_page_actions_button_clicked_delete
                                                            (void);

The button "delete action" has been clicked so delete the current action.

### gok_page_actions_button_clicked_change_name ()

    void                gok_page_actions_button_clicked_change_name
                                                            (void);

The button "change name" has been clicked so allow the user to change the name of the action.

### gok_page_actions_action_changed ()

    void                gok_page_actions_action_changed     (GtkComboBox *combo);

The user has selected a new action from the combo box so update the page's controls with the new action data.

`combo` : | Pointer to the combo box that contains the names of the actions.

### gok_page_actions_enable_switch_controls ()

    void                gok_page_actions_enable_switch_controls
                                                            (gboolean bTrueFalse);

Enables/disables the controls for switch actions.

`bTrueFalse` : | State that the switch controls should be set to.

### gok_page_actions_enable_radios_type ()

    void                gok_page_actions_enable_radios_type (gboolean bTrueFalse);

Enables/disables the radio buttons for action type.

`bTrueFalse` : | State the controls should be set to.

### gok_page_actions_fill_combo_action_names ()

    void                gok_page_actions_fill_combo_action_names
                                                            (void);

Fills the combo box that displays the action names.

### gok_page_actions_get_radio_number ()

    gint                gok_page_actions_get_radio_number   (GtkRadioButton *pRadioButtonGiven);

`pRadioButtonGiven` : |
Returns : |

### gok_page_actions_update_controls ()

    void                gok_page_actions_update_controls    (GokAction *pAction);

Updates the controls so they reflect the given action.

`pAction` : | Controls are changed to display this action.

### gok_page_actions_set_number ()

    void                gok_page_actions_set_number         (gint NumberSwitch);

`NumberSwitch` : | Number of the switch selected.

### gok_page_actions_set_state ()

    void                gok_page_actions_set_state          (gint State);

`State` : | State selected.

### gok_page_actions_set_rate ()

    void                gok_page_actions_set_rate           (gint Rate);

`Rate` : | Rate selected.