HildonWizardDialog

HildonWizardDialog — A widget to create a guided installation process wizard.

Synopsis


#include <hildon/hildon.h>

enum                HildonWizardDialogResponse;
                    HildonWizardDialog;
gboolean            (*HildonWizardDialogPageFunc)       (GtkNotebook *notebook,
                                                         gint current_page,
                                                         gpointer data);
GtkWidget*          hildon_wizard_dialog_new            (GtkWindow *parent,
                                                         const char *wizard_name,
                                                         GtkNotebook *notebook);
void                hildon_wizard_dialog_set_forward_page_func
                                                        (HildonWizardDialog *wizard_dialog,
                                                         HildonWizardDialogPageFunc page_func,
                                                         gpointer data,
                                                         GDestroyNotify destroy);

Object Hierarchy

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

Implemented Interfaces

HildonWizardDialog implements AtkImplementorIface and GtkBuildable.

Properties

  "autotitle"                gboolean              : Read / Write
  "wizard-name"              gchar*                : Read / Write
  "wizard-notebook"          GtkNotebook*          : Read / Write

Description

HildonWizardDialog is a widget to create a guided installation process. The dialog has three standard buttons, previous, next, finish, and contains several pages.

Response buttons are dimmed/undimmed automatically. The notebook widget provided by users contains the actual wizard pages.

Usage of the API is very simple, it has only one function to create it and the rest of it is handled by developers notebook. Also, the response is returned, either cancel or finish. Next and previous buttons are handled by the wizard dialog it self, by switching the page either forward or backward in the notebook.

It is possible to determinate whether users can go to the next page by setting a HildonWizardDialogPageFunc function with hildon_wizard_dialog_set_forward_page_func()

Details

enum HildonWizardDialogResponse

typedef enum
{
    HILDON_WIZARD_DIALOG_CANCEL = GTK_RESPONSE_CANCEL,
    HILDON_WIZARD_DIALOG_PREVIOUS = 0,
    HILDON_WIZARD_DIALOG_NEXT,
    HILDON_WIZARD_DIALOG_FINISH
}                                               HildonWizardDialogResponse;

Predefined values for use as response ids for HildonWizardDialog.

Warning

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

`HILDON_WIZARD_DIALOG_CANCEL`	Returned by the 'Cancel' button.
`HILDON_WIZARD_DIALOG_PREVIOUS`	Returned by the 'Previous' button.
`HILDON_WIZARD_DIALOG_NEXT`	Returned by the 'Next' button.
`HILDON_WIZARD_DIALOG_FINISH`	Returned by the 'Finish' button.