[kdeui Index] [kdeui Hierarchy] [Headers]
KNoteBook More...
#include <knotebook.h>
Inherits: KDialog
KNoteBook is a tabbed dialog where each tab can have multiple pages. The widget has the advantages of both KTabCtl and QTabDialog plus some more.
Features:
- Multiple pages per tab with previous/next button and optional arrow buttons in the title..
- An optional popup menu which takes you to a specific page in a specific section (tab).
- Easy additions of Ok, Cancel, Default and Help buttons.
- Automatic resizing/repainting/repositioning of buttons. Not like QTabDialog where there is always an Ok button.
- Scrollable tab bar.
- Can be used as both modal/non-modal dialog and a child widget.
[public]
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(); }
name | The internal name. |
parent | The parent of the notebook. |
modal | If modal is true the notebook wil become a modal dialog. |
f | Window flags. |
[public]
Destructor
[public]
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().
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); |
tab | The QTab containing the tab data. |
[public]
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().
p | The KWizardPage containing the page data.. |
[public]
Turn to another tab. This method calls showSection to show the corresponding KWizard.
tab | The tab to turn to |
[public]
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.
[public]
Adds a Cancel button to the bottom of the dialog.
text | A user supplied text to write to the button. |
[public]
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.
[public]
Adds a Default button to the bottom of the dialog.
text | A user supplied text to write to the button. |
[public]
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.
[public]
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.
text | A user supplied text to write to the button. |
[public]
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.
[public]
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.
text | A user supplied text to write to the button. |
[public]
Get Ok button.
[public]
Get Cancel button.
[public]
Get Default button.
[public]
Get Help button.
[public]
Let direction buttons reflect page.
state | If state is true the direction buttons (Previous and Next) will have the title of the corresponding page. |
[public]
[public]
En/Disable the popup menu.
state | If state is true a menu containing the pages in the wizard will popup when the user RMB-clicks on the page-title. |
[public]
Returns whether the menu is enabled or not.
[public]
Get the popup menu.
[public]
En/Disable the arrowbuttons.
state | If state is true two arrows will appear to the right of the title. |
[public]
[public]
Returns the handle of the tab bar.
[public]
Returns the number of tabs in the notebook.
[public]
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.
[public]
[public]
En/Disable a page in a section (tab) in the notebook
[public]
[protected slot]
Called by gotoTab to show the appropriate KWizard.
[protected slot]
For internal use only.
If the menu is enabled by enablePopupMenu this method will let the menu popup at 'pos'.
[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.
| Kdoc |