## GnomeDruidPage

GnomeDruidPage — A widget representing a single page inside a druid.

## Synopsis

    #include <libgnomeui/libgnomeui.h>

                        GnomeDruidPage;
    GtkWidget *         gnome_druid_page_new                (void);
    gboolean            gnome_druid_page_next               (GnomeDruidPage *druid_page);
    void                gnome_druid_page_prepare            (GnomeDruidPage *druid_page);
    gboolean            gnome_druid_page_back               (GnomeDruidPage *druid_page);
    gboolean            gnome_druid_page_cancel             (GnomeDruidPage *druid_page);
    void                gnome_druid_page_finish             (GnomeDruidPage *druid_page);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBin
                                     +----GnomeDruidPage
                                           +----GnomeDruidPageEdge
                                           +----GnomeDruidPageStandard

## Implemented Interfaces

GnomeDruidPage implements GtkBuildable and AtkImplementorIface.

## Signals

      "back"                                           : Run Last
      "cancel"                                         : Run Last
      "finish"                                         : Run Last
      "next"                                           : Run Last
      "prepare"                                        : Run Last

## Description

The functions in this page are mostly only for the information of developers -- they should never need to call them directly. Typically, a druid will connect to the various signals described here as a way of controlling the behaviour of druids that do not just proceed in a front-to-back fashion (for example, where the subsequent pages depend upon the choice made at some point).

## Details

### GnomeDruidPage

    typedef struct _GnomeDruidPage GnomeDruidPage;

### Warning

`GnomeDruidPage` is deprecated and should not be used in newly-written code.

The widget for a aprticular page in a druid.

### gnome_druid_page_new ()

    GtkWidget *         gnome_druid_page_new                (void);

### Warning

`gnome_druid_page_new` is deprecated and should not be used in newly-written code.

Creates a new GnomeDruidPage.

Returns : | The newly created GnomeDruidPage.

### gnome_druid_page_next ()

    gboolean            gnome_druid_page_next               (GnomeDruidPage *druid_page);

### Warning

`gnome_druid_page_next` is deprecated and should not be used in newly-written code.

This will emit the "next" signal for that particular page. It is called by gnome-druid exclusively. It is expected that non-linear Druid's will override this signal and return TRUE if it handles changing pages.

`druid_page` : | A DruidPage widget.
Returns : | This function will return FALSE by default.

### gnome_druid_page_prepare ()

    void                gnome_druid_page_prepare            (GnomeDruidPage *druid_page);

### Warning

`gnome_druid_page_prepare` is deprecated and should not be used in newly-written code.

This emits the "prepare" signal for the page. It is called by gnome-druid exclusively. This function is called immediately prior to a druid page being shown so that it can "prepare" for display.

`druid_page` : | A DruidPage widget.

### gnome_druid_page_back ()

    gboolean            gnome_druid_page_back               (GnomeDruidPage *druid_page);

### Warning

`gnome_druid_page_back` is deprecated and should not be used in newly-written code.

This will emit the "back" signal for that particular page. It is called by gnome-druid exclusively. It is expected that non-linear Druid's will override this signal and return TRUE if it handles changing pages.

`druid_page` : | A DruidPage widget.
Returns : | This function will return FALSE by default.

### gnome_druid_page_cancel ()

    gboolean            gnome_druid_page_cancel             (GnomeDruidPage *druid_page);

### Warning

`gnome_druid_page_cancel` is deprecated and should not be used in newly-written code.

This will emit the "cancel" signal for that particular page. It is called by gnome-druid exclusively. It is expected that a Druid will override this signal and return TRUE if it does not want to exit.

`druid_page` : | A DruidPage widget.
Returns : | This function will return FALSE by default.

### gnome_druid_page_finish ()

    void                gnome_druid_page_finish             (GnomeDruidPage *druid_page);

### Warning

`gnome_druid_page_finish` is deprecated and should not be used in newly-written code.

This emits the "finish" signal for the page. It is called by gnome-druid exclusively.

`druid_page` : | A DruidPage widget.

## Signal Details

### The `"back"` signal

    gboolean            user_function                      (GnomeDruidPage *druidpage,
                                                            GtkWidget      *widget,
                                                            gpointer        user_data)      : Run Last

`druidpage` : | the object which received the signal.
`widget` : | The GnomeDruid containg this page.
`user_data` : | user data set when the signal handler was connected.
Returns : | %TRUE if the signal handler has changed the page (since this stops all further emission of the signal), `FALSE` otherwise.

### The `"cancel"` signal

    gboolean            user_function                      (GnomeDruidPage *druidpage,
                                                            GtkWidget      *widget,
                                                            gpointer        user_data)      : Run Last

`druidpage` : | the object which received the signal.
`widget` : | The GnomeDruid containg this page.
`user_data` : | user data set when the signal handler was connected.
Returns : | %TRUE if the druid does not want to exit yet, `FALSE` if the exit should continue.

### The `"finish"` signal

    void                user_function                      (GnomeDruidPage *druidpage,
                                                            GtkWidget      *widget,
                                                            gpointer        user_data)      : Run Last

`druidpage` : | the object which received the signal.
`widget` : | The GnomeDruid containg this page.
`user_data` : | user data set when the signal handler was connected.

### The `"next"` signal

    gboolean            user_function                      (GnomeDruidPage *druidpage,
                                                            GtkWidget      *widget,
                                                            gpointer        user_data)      : Run Last

`druidpage` : | the object which received the signal.
`widget` : | The GnomeDruid containg this page.
`user_data` : | user data set when the signal handler was connected.
Returns : | %TRUE if the signal handler has changed the page (since this stops all further emission of the signal), `FALSE` otherwise.

### The `"prepare"` signal

    void                user_function                      (GnomeDruidPage *druidpage,
                                                            GtkWidget      *widget,
                                                            gpointer        user_data)      : Run Last

`druidpage` : | the object which received the signal.
`widget` : | The GnomeDruid containg this page.
`user_data` : | user data set when the signal handler was connected.