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

Signal Prototypes


"next"      gboolean    user_function      (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);
"prepare"   void        user_function      (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);
"back"      gboolean    user_function      (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);
"finish"    void        user_function      (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);
"cancel"    gboolean    user_function      (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);

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.

Signals

The "next" signal

gboolean    user_function                  (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);

This signal is emitted by the druid when the "next" button is pressed. It is overridden by the application when it wants to go to a different page. If the signal returns TRUE, then it has handled the control-flow, and the druid will not change the page.

druidpage :the object which received the signal.
arg1 :the druid that emitted the signal.
user_data :user data set when the signal handler was connected.
Returns :TRUE or FALSE.


The "prepare" signal

void        user_function                  (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);

This signal is sent to all pages just before they are shown. It gives them an opportunity to prepare the page before it is realized.

druidpage :the object which received the signal.
arg1 :the druid that emitted the signal.
user_data :user data set when the signal handler was connected.


The "back" signal

gboolean    user_function                  (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);

This signal is emitted by the druid when the "back" button is pressed. It is overridden by the application when it wants to go to a different page. If the signal returns TRUE, then it has handled the control-flow, and the druid will not change the page.

druidpage :the object which received the signal.
arg1 :the druid that emitted the signal.
user_data :user data set when the signal handler was connected.
Returns :TRUE or FALSE.


The "finish" signal

void        user_function                  (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);

This signal is sent when the "finish" button is pressed on the druid. It should finish setting up whatever the druid is doing, and quit.

druidpage :the object which received the signal.
arg1 :the druid that emitted the signal.
user_data :user data set when the signal handler was connected.


The "cancel" signal

gboolean    user_function                  (GnomeDruidPage *druidpage,
                                            gpointer arg1,
                                            gpointer user_data);

This signal is sent when the "cancel" button is pressed on the druid. It should put up a dialog, if needed, to confirm the users' exit. If it does intend to quit, it should return FALSE, which will cause arg1 to emit it's "cancel" signal. If it returns TRUE, it is assumed that the DRUID does not want to quit, and it will keep running. This return value should be used with some caution.

druidpage :the object which received the signal.
arg1 :the druid that emitted the signal.
user_data :user data set when the signal handler was connected.
Returns :TRUE or FALSE.

See Also

GnomeDruid, GnomeDruidPageStart, GnomeDruidPageStandard, GnomeDruidPageFinish