|
|
KWizard is a multi-purpose dialog. It is very useful for:
- Configuration dialogs where the order in which the entries are filled is important.
- Tutorials. Just create some HTML-widgets and feed them to a KWizard and your done (almost).
- NoteBooks. KWizard is an integrated part of KNoteBook which provides a notebook dialog similar to the ones in OS/2 Warp 4.
- Propably many other things...
The dialog contains:
- A title at the top of the page.
- A separator.
- The userprovided page-widget.
- A separator.
- A label indicating the pagination.
- A Previous and a Next button.
- Optionally Ok, Cancel and Help buttons.
KWizard (QWidget *parent = 0, const char *name = 0, bool modal = false, WFlags f = 0) |
Constructor
~KWizard () |
Destructor
int addPage (KWizardPage *p) |
Adds a page to the wizard. The pages are numbered from 0-n where 0 is the page first added and n is the page last added.
Parameters:
p | KWizardPage containing the page data. |
Returns: Returns the id of the new page.
void setPage (int id, QWidget *w) |
Changes the QWidget on the page with id "id" to "w".
void setPage (int id, QString title) |
Changes the title on the page with id "id" to "title".
void setPageEnabled (int page, bool state) |
En/disable a specified page. If a page is disable its content will be grayd out and it will not receive keyboard input.
Parameters:
page | The page to en/disable. |
state | If 'state' is false the page will be disabled, otherwise it will be enabled. |
See also: setPageEnabled
bool isPageEnabled (int page) |
Check the state of the page.
Returns: Returns true if the page is enabled, otherwise false.
See also: setPageEnabled
void setCancelButton () |
Adds a Cancel button to the bottom of the dialog. The text will be a translated version of the string '&Cancel' thereby giving it the shortcut key 'c'. If any buttons are added a space will be created at the bottom of the dialog to fit the buttons. When clicked the button will emit the cancelclicked signal.
See also: translate
void setCancelButton (const char *text) |
Adds a Cancel button to the bottom of the dialog.
Parameters:
text | A user supplied text to write to the button. |
void setDefaultButton () |
Adds a Default button to the bottom of the dialog. The text will be a translated version of the string '&Default' thereby giving it the shortcut key 'd'. If any buttons are added a space will be created at the bottom of the dialog to fit the buttons. When clicked the button will emit the defaultclicked signal.
See also: translate
void setDefaultButton (const char *text) |
Adds a Default button to the bottom of the dialog.
Parameters:
text | A user supplied text to write to the button. |
void setHelpButton () |
Adds a Help button to the bottom right of the dialog. The text will be a translated version of the string '&Help' thereby giving it the shortcut key 'h'. If any buttons are added a space will be created at the bottom of the dialog to fit the buttons. When clicked the button will emit the helpclicked signal.
See also: getHelpButton
void setHelpButton (const char *) |
Adds a Help button to the bottom of the dialog. This button will generate the signal helpclicked where the int is the page to which the help was requested.
Parameters:
text | A user supplied text to write to the button. |
See also: getHelpButton
void setOkButton () |
Adds an Ok button to the bottom right of the dialog. The text will be a translated version of the string '&Ok' thereby giving it the shortcut key 'o'. If any buttons are added a space will be created at the bottom of the dialog to fit the buttons. When clicked the button will emit the okclicked signal.
See also: getOkButton
void setOkButton (const char *) |
Adds an Ok button to the bottom of the dialog. This button will generate the signal okclicked where the int is the page to which the help was requested.
Parameters:
text | A user supplied text to write to the button. |
See also: getOkButton
QButton * getOkButton () |
Returns: Returns the Ok buttonwidget or 0L if no button is added.
See also: setOkButton
QButton * getCancelButton () |
Returns: Returns the Cancel buttonwidget or 0L if no button is added.
See also: setCancelButton
QButton * getDefaultButton () |
Returns: Returns the Default buttonwidget or 0L if no button is added.
See also: setDefaultButton
QButton * getHelpButton () |
Returns: Returns the Help buttonwidget or 0L if no button is added.
See also: setHelpButton
QButton * getNextButton () |
getNextButton.
Returns: Returns the Next buttonwidget.
QButton * getPreviousButton () |
getPreviousButton
Returns: Returns the Previous buttonwidget.
KDirectionButton * getLeftArrow () |
Returns: Returns the left arrowbutton.
See also: setEnableArrowButtons
KDirectionButton * getRightArrow () |
Returns: Returns the right arrowbutton.
See also: setEnableArrowButtons
void setDirectionsReflectsPage (bool state) |
Let direction buttons reflect page.
Parameters:
state | If state is true the direction buttons (Previous and Next) will have the title of the corresponding page. |
See also: directionsReflectsPage
bool directionsReflectsPage () |
Returns: Returns whether the direction buttons reflects the title of the corresponding page.
See also: setDirectionsReflectsPage(bool, state)
void setEnablePopupMenu (bool state) |
En/Disable the popup menu.
Parameters:
state | If state is true a menu containing the pages in the wizard will popup when the user RMB-clicks on the page-title. |
See also: enablePopupMenu
bool enablePopupMenu () |
Returns: Returns 'true' if the popupmenu is enabled.
See also: setEnablePopupMenu
QPopupMenu * getMenu () |
getMenu
Returns: Returns the handle of the popup menu.
See also: setEnablePopupMenu, enablePopupMenu
void setEnableArrowButtons (bool state) |
En/Disable the arrow buttons at the rightmost of the title.
Parameters:
state | If state is true two arrows will appear to the right of the pagination allowing the user to change pages by clicking on them. |
See also: enableArrowButtons
bool enableArrowButtons () |
Returns: Returns 'true' if the arrow buttons are enabled.
See also: setEnableArrowButtons
const char * getTitle (int page) |
getTitle
Parameters:
page | The page to retrieve the title from. |
Returns: Returns the title of a specified page. Used by KNoteBook
int numPages () |
numPages
Returns: Returns the number of pages in the wizard.
void okclicked () |
This signal is emitted when the user clicks on the Ok button.
void cancelclicked () |
This signal is emitted when the user clicks on the Cancel button.
void defaultclicked (int) |
This signal is emitted when the user clicks on the Default button. The int is the page which was showing when default settings was requested.
void helpclicked (int) |
This signal is emitted when the user clicks on the Help button. The int is the page which was showing when help was requested.
See also: setHelpButton, getHelpButton, getHelpButton
void selected (int) |
This signal is emitted when a page is selected. The int is the page number
void closed () |
This signal is emitted when the dialog is closed. Mainly usable if the dialog is a top level widget.
void popup (QPoint) |
This signal is emitted when a popup menu is requested. This happens when the user RMB-clicks somewhere in the title (not the titlebar). This is used by KNoteBook.
void nomorepages (bool, bool) |
This signal is used by KNoteBook.
QSize pageSize () |
void setSizes () |
void resizeEvent (QResizeEvent *) |
void paintEvent (QPaintEvent *) |