## gok-page-accessmethod

gok-page-accessmethod

## Synopsis

    gboolean            gok_page_accessmethod_initialize    (GladeXML *xml);
    gboolean            gok_page_accessmethod_apply         (void);
    gboolean            gok_page_accessmethod_apply_controls
                                                            (GokControl *pControl,
                                                             gchar *NameAccessMethod);
    gboolean            gok_page_accessmethod_revert        (void);
    void                gok_page_accessmethod_backup        (void);
    void                gok_page_accessmethod_change_controls
                                                            (gchar *pNameAccessMethod);
    void                gok_page_accessmethod_draw_controls (gchar *NameAccessMethod,
                                                             GokControl *pControlParent,
                                                             GokControl *pControl,
                                                             GtkSizeGroup *pSizeGroup,
                                                             gboolean bShow);
    void                gok_page_accessmethod_update_controls
                                                            (gchar *NameAccessMethod,
                                                             GokControl *pControl);
    gchar*              gok_page_accessmethod_get_displayname
                                                            (gchar *NameAccessMethod);
    gchar*              gok_page_accessmethod_get_name      (gchar *DisplayNameAccessMethod);

## Description

## Details

### gok_page_accessmethod_initialize ()

    gboolean            gok_page_accessmethod_initialize    (GladeXML *xml);

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

`xml` : | Pointer to the Glade UI description of the settings dialog.
Returns : | TRUE if the page was properly initialized, FALSE if not.

### gok_page_accessmethod_apply ()

    gboolean            gok_page_accessmethod_apply         (void);

Updates the gok data with values from the controls.

Returns : | TRUE if any settings have changed, FALSE if no settings have changed.

### gok_page_accessmethod_apply_controls ()

    gboolean            gok_page_accessmethod_apply_controls
                                                            (GokControl *pControl,
                                                             gchar *NameAccessMethod);

Updates the gok data with values from the controls. This function is recursive and gets the data from the next and child controls of the one given.

`pControl` : | Pointer to the control that you want to get the data from.
`NameAccessMethod` : | Name of the access method that the control belongs to.
Returns : | TRUE if any conrol value has changed. Returns FALSE if all control values are the same.

### gok_page_accessmethod_revert ()

    gboolean            gok_page_accessmethod_revert        (void);

Revert to the backup settings for this page and store them in the gok_data.

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

### gok_page_accessmethod_backup ()

    void                gok_page_accessmethod_backup        (void);

Copies all the member settings to backup.

### gok_page_accessmethod_change_controls ()

    void                gok_page_accessmethod_change_controls
                                                            (gchar *pNameAccessMethod);

Display the controls for the given access method.

`pNameAccessMethod` : | Name of the access method.

### gok_page_accessmethod_draw_controls ()

    void                gok_page_accessmethod_draw_controls (gchar *NameAccessMethod,
                                                             GokControl *pControlParent,
                                                             GokControl *pControl,
                                                             GtkSizeGroup *pSizeGroup,
                                                             gboolean bShow);

Draws the controls for the GokControl.

`NameAccessMethod` : | Name of the access methods that needs the controls.
`pControlParent` : | Pointer to the GOK control that will contain the new controls.
`pControl` : | Pointer to the GokControl that you want drawn.
`pSizeGroup` : | Pointer to the GtkSizeGroup the control belongs to.
`bShow` : | If TRUE then the controls will be show, if FALSE they will be hidden.

### gok_page_accessmethod_update_controls ()

    void                gok_page_accessmethod_update_controls
                                                            (gchar *NameAccessMethod,
                                                             GokControl *pControl);

Updates all the controls on the page with values from the settings.

`NameAccessMethod` : | Name of the access method.
`pControl` : | Pointer to the control that will be updated.

### gok_page_accessmethod_get_displayname ()

    gchar*              gok_page_accessmethod_get_displayname
                                                            (gchar *NameAccessMethod);

`NameAccessMethod` : | Name of the access method.
Returns : | The display name of the given access method.

### gok_page_accessmethod_get_name ()

    gchar*              gok_page_accessmethod_get_name      (gchar *DisplayNameAccessMethod);

`DisplayNameAccessMethod` : | Display name of the access method.
Returns : | The name of the given access method.