KPageWidget Class
Page widget with many layouts (faces). More...
| Header: | #include <KPageWidget> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS WidgetsAddons)target_link_libraries(mytarget PRIVATE KF6::WidgetsAddons) |
| Inherits: | KPageView |
Public Functions
| KPageWidget(QWidget *parent = nullptr) | |
| void | addPage(KPageWidgetItem *item) |
| KPageWidgetItem * | addPage(QWidget *widget, const QString &name) |
| void | addSubPage(KPageWidgetItem *parent, KPageWidgetItem *item) |
| KPageWidgetItem * | addSubPage(KPageWidgetItem *parent, QWidget *widget, const QString &name) |
| KPageWidgetItem * | currentPage() const |
| void | insertPage(KPageWidgetItem *before, KPageWidgetItem *item) |
| KPageWidgetItem * | insertPage(KPageWidgetItem *before, QWidget *widget, const QString &name) |
| void | removePage(KPageWidgetItem *item) |
| void | setCurrentPage(KPageWidgetItem *item) |
Signals
| void | currentPageChanged(KPageWidgetItem *current, KPageWidgetItem *before) |
| void | pageRemoved(KPageWidgetItem *page) |
| void | pageToggled(KPageWidgetItem *page, bool checked) |
Detailed Description
A KPageView with hierarchical page model.
Member Function Documentation
[explicit] KPageWidget::KPageWidget(QWidget *parent = nullptr)
Creates a new page widget.
parent The parent widget.
void KPageWidget::addPage(KPageWidgetItem *item)
Adds a new top level page to the widget.
item The KPageWidgetItem which describes the page.
KPageWidgetItem *KPageWidget::addPage(QWidget *widget, const QString &name)
Adds a new top level page to the widget.
widget The widget of the page.
name The name which is displayed in the navigation view.
Returns The associated KPageWidgetItem.
void KPageWidget::addSubPage(KPageWidgetItem *parent, KPageWidgetItem *item)
Inserts a new sub page in the widget.
parent The new page will be insert as child of this KPageWidgetItem.
item The KPageWidgetItem which describes the page.
KPageWidgetItem *KPageWidget::addSubPage(KPageWidgetItem *parent, QWidget *widget, const QString &name)
Inserts a new sub page in the widget.
parent The new page will be insert as child of this KPageWidgetItem.
widget The widget of the page.
name The name which is displayed in the navigation view.
Returns the associated KPageWidgetItem.
KPageWidgetItem *KPageWidget::currentPage() const
Returns the KPageWidgetItem for the current page or a null pointer if there is no current page.
See also setCurrentPage().
[signal] void KPageWidget::currentPageChanged(KPageWidgetItem *current, KPageWidgetItem *before)
This signal is emitted whenever the current page has changed.
current The new current page or a null pointer if no current page is available.
before The page that was current before the new current page has changed.
void KPageWidget::insertPage(KPageWidgetItem *before, KPageWidgetItem *item)
Inserts a new page in the widget.
before The new page will be insert before this KPageWidgetItem on the same level in hierarchy.
item The KPageWidgetItem which describes the page.
KPageWidgetItem *KPageWidget::insertPage(KPageWidgetItem *before, QWidget *widget, const QString &name)
Inserts a new page in the widget.
before The new page will be insert before this KPageWidgetItem on the same level in hierarchy.
widget The widget of the page.
name The name which is displayed in the navigation view.
Returns the associated KPageWidgetItem.
[signal] void KPageWidget::pageRemoved(KPageWidgetItem *page)
This signal is emitted when a page is removed.
page The page which is removed
[signal] void KPageWidget::pageToggled(KPageWidgetItem *page, bool checked)
This signal is emitted whenever a checkable page changes its state. checked is true when the page is checked, or false if the page is unchecked.
void KPageWidget::removePage(KPageWidgetItem *item)
Removes the page associated with the given KPageWidgetItem.
void KPageWidget::setCurrentPage(KPageWidgetItem *item)
Sets the page which is associated with the given KPageWidgetItem to be the current page and emits the currentPageChanged() signal.
See also currentPage().