## SwamiguiPref SwamiguiPref — Swami preferences widget and registration |

## Stability Level

Stable, unless otherwise indicated

## Synopsis

                        SwamiguiPref;
    GtkWidget *         (*SwamiguiPrefHandler)              (void);
    #define             SWAMIGUI_PREF_ORDER_NAME
    void                swamigui_register_pref_handler      (const char *name,
                                                             const char *icon,
                                                             int order,
                                                             SwamiguiPrefHandler handler);
    GtkWidget *         swamigui_pref_new                   (void);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBin
                                     +----GtkWindow
                                           +----GtkDialog
                                                 +----SwamiguiPref

## Implemented Interfaces

SwamiguiPref implements AtkImplementorIface and GtkBuildable.

## Description

Swami GUI preferences widget and preference interface registration.

## Details

### SwamiguiPref

    typedef struct _SwamiguiPref SwamiguiPref;

### SwamiguiPrefHandler ()

    GtkWidget *         (*SwamiguiPrefHandler)              (void);

Function prototype to create a GUI preference interface.

Returns : | The toplevel widget of the preference interface.

### SWAMIGUI_PREF_ORDER_NAME

    #define SWAMIGUI_PREF_ORDER_NAME	0

Value to use for order parameter of `swamigui_register_pref_handler()` to sort by name. This should be used for plugins and other interfaces where specific placement in the preferences list is not needed.

### swamigui_register_pref_handler ()

    void                swamigui_register_pref_handler      (const char *name,
                                                             const char *icon,
                                                             int order,
                                                             SwamiguiPrefHandler handler);

Register a preferences interface which will become a part of the preferences widget.

`name` : | Name of the preference interface (shown in list with icon)
`icon` : | Name of stock icon for interface (shown in list with name)
`order` : | Order of the interface in relation to others (the lower the number the higher on the list, use SWAMIGUI_PREF_ORDER_NAME to indicate that the interface should be sorted by name - after other interfaces which specify a specific value).

### swamigui_pref_new ()

    GtkWidget *         swamigui_pref_new                   (void);

Create preferences dialog widget.

Returns : | New preferences dialog widget.