Gnome User Interface Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GnomeDruidPage

## Name

GnomeDruidPage -- A virtual widget defining the druid page.

## Synopsis

    #include <gnome.h>

    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

      GtkObject
       +----GtkWidget
             +----GtkContainer
                   +----GtkBin
                         +----GnomeDruidPage

## Description

This widget is a virtual widget to define the interface to a druid page. It's descendants are placed in GnomeDruid, and comprise of the actual material in the widget.

## Details

### gnome_druid_page_next ()

    gboolean    gnome_druid_page_next           (GnomeDruidPage *druid_page);

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);

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

`druid_page` : | A DruidPage widget.

### gnome_druid_page_back ()

    gboolean    gnome_druid_page_back           (GnomeDruidPage *druid_page);

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);

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);

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

`druid_page` : | A DruidPage widget.

## See Also

GnomeDruid, GnomeDruidPageStart, GnomeDruidPageStandard, GnomeDruidPageFinish

<<< Previous Page | Home | Up | Next Page >>>
GnomeDruid | GnomeDruidPageStart