class KNoteBook

Public Methods

•  KNoteBook (QWidget *parent = 0, const char *name = 0, bool modal = false, WFlags f = 0)
• ~ KNoteBook ()
• int  addTab (QTab *tab, KWizardPage *p = 0L)
• int  addPage (KWizardPage *p)
• void  gotoTab (int tab)
• QSize  sizeHint ()
• void  adjustSize ()
• void  setCancelButton ()
• void  setCancelButton (const char *text)
• void  setDefaultButton ()
• void  setDefaultButton (const char *text)
• void  setHelpButton ()
• void  setHelpButton (const char *)
• void  setOkButton ()
• void  setOkButton (const char *)
• QButton * getOkButton ()
• QButton * getCancelButton ()
• QButton * getDefaultButton ()
• QButton * getHelpButton ()
• void  setDirectionsReflectsPage (bool state)
• bool  directionsReflectsPage ()
• void  setEnablePopupMenu (bool state)
• bool  enablePopupMenu ()
• QPopupMenu * getMenu ()
• void  setEnableArrowButtons (bool state)
• bool  enableArrowButtons ()
• KTabBar * getTabBar ()
• int  numTabs ()
• void  setTabEnabled (int tab, bool state)
• bool  isTabEnabled (int tab)
• void  setPageEnabled (int tab, int page, bool state)
• bool  isPageEnabled (int tab, int page)

Signals

• void  okclicked ()
• void  cancelclicked ()
• void  defaultclicked (int)
• void  helpclicked (int)

Protected Methods

• void  init ()
• void  resizeEvent (QResizeEvent *)
• void  paintEvent (QPaintEvent *)
• void  setSizes ()
• QSize  childSize ()

Protected Slots

• void  showSection (int)
• void  popupMenu (QPoint pos)
• void  menuChoice (int)
• void  menuChoiceRedirect (int)
• void  directionButton (bool, bool)
• void  okClicked ()
• void  cancelClicked ()
• void  defaultClicked ()
• void  helpClicked ()
• void  tabScroll ( ArrowType )

Protected Members

• KNoteBookProtected *pnote
• QList<KWizard> *sections

Constructs a KNoteBook.

A modal notebook can be created like this:

 KNoteBook *nb = new KNoteBook(this, "notebook", true);
 connect(nb, SIGNAL(okclicked()), SLOT(nb->hide()));
 connect(nb, SIGNAL(okclicked()), SLOT(readNewInput()));

A very simple program where the main window is a KNoteBook with one tab and one page inserted could look like this:

 int main(int argc, char **argv)
 {
   KApplication a(argc,argv,"knotebooktest");  // create an application object
   KNoteBook *nb = new KNoteBook(); // create the notebook
   nb->setCancelButton();           // add a Cancel button and connect it to the quit() slot
   QObject::connect( nb, SIGNAL(cancelclicked()), &a, SLOT(quit()) );
 
   QTab *tab = new QTab;            // create a QTab to hold the tab data
   tab->label = "A tab";
   tab->enabled = true;
   nb->addTab( tab );
   QLabel *l = new QLabel(nb);
   l->setAlignment(AlignCenter);
   l->setText("This is a QLabel as a page");
   l->setMinimumSize(400, 300);
   KWizardPage *p = new KWizardPage;
   p->w = l;
   p->title.setNum("A page title");
   p->enabled = true;
   nb->addPage( p );
 
   a.setMainWidget(nb);
   nb->adjustSize();
   nb->show();
   return a.exec();
 }

Parameters:

parent	The parent of the notebook.
name	The internal name.
modal	If modal is true the notebook wil become a modal dialog.
f	Window flags.

Destructor

Adds a new tab to the notebook and creates a new KWizard to hold the pages. The tabs are numbered from 0 to n where 0 is the tab first added and n is the tab last added. if you add 4 tabs the last tab will be number 3. Subsequent calls to addPage will add pages to this tab until a new call to addTab().

Parameters:

tab	The QTab containing the tab data.
p	The optional KWizardPage containing the page data.If 'p' is not 0 it will be added as a new page. This is equivalent to addPage (p);

Returns: Returns the id of the new tab.

Adds a new page to the last added tab. The pages are numbered from 0 to n where 1 is the page first added and n is the page last added. Subsequent calls to addPage will add pages to the last added tab until a new call to addTab().

Parameters:

p	The KWizardPage containing the page data..

Returns: Returns the id of the new page. The id is relative to the KWizard, NOT the KNoteBook.

Turn to another tab. This method calls showSection to show the corresponding KWizard.

Parameters:

tab	The tab to turn to

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.

Adds a Cancel button to the bottom of the dialog.

Parameters:

text	A user supplied text to write to the button.

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.

Adds a Default button to the bottom of the dialog.

Parameters:

text	A user supplied text to write to the button.

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.

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.

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.

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.

Get Ok button.

Returns: Returns the Ok buttonwidget or 0L if no button is added.

Get Cancel button.

Returns: Returns the Cancel buttonwidget or 0L if no button is added.

Get Default button.

Returns: Returns the Default buttonwidget or 0L if no button is added.

Get Help button.

Returns: Returns the Help buttonwidget or 0L if no button is added.

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.

Returns: Returns whether the direction buttons reflects the title of the corresponding page.

See also: setDirectionsReflectsPage(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.

Returns whether the menu is enabled or not.

Returns: 'true' if the menu is enabled, otherwise 'false'.

Get the popup menu.

Returns: Returns the handle of the popup menu.

En/Disable the arrowbuttons.

Parameters:

state

If state is true two arrows will appear to the right of the title.

See also: enableArrowButtons, KWizard#setEnableArrowButtons.

Returns: Returns whether the arrow buttons are enabled or not.

See also: setEnableArrowButtons, KWizard#enableArrowButtons.

Returns the handle of the tab bar.

Returns the number of tabs in the notebook.

En/Disable a tab in the notebook. If a tab is disabled it is not selectable from the tab bar. If the user reaches a disabled tab by traversing through the pages the notebook will jump to the next enabled tab.

Returns: Returns whether the tab is enabled or not.

En/Disable a page in a section (tab) in the notebook

Returns: Returns whether a page in a section (tab) is enabled or not.

[signal]

This signal is emitted when the user clicks on the Ok button.

[signal]

This signal is emitted when the user clicks on the Cancel button.

[signal]

This signal is emitted when the user clicks on the Default button.

[signal]

This signal is emitted when the user clicks on the Help button. The int is the page which was showing when help was requested.

[protected slot]

Called by gotoTab to show the appropriate KWizard.

[protected slot]

If the menu is enabled by enablePopupMenu this method will let the menu popup at 'pos'.

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected slot]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

• Version: 0.3
• Author: Thomas Tanghus <tanghus@earthling.net>
• Generated: root@george.devel.redhat.com on Thu Sep 14 21:18:43 2000, using kdoc 2.0a36.