KPageWidgetModel Class
This page model is used by KPageWidget to provide a hierarchical layout of pages. More...
| Header: | #include <KPageWidgetModel> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS WidgetsAddons)target_link_libraries(mytarget PRIVATE KF6::WidgetsAddons) |
| Inherits: | KPageModel |
Public Functions
| KPageWidgetModel(QObject *parent = nullptr) | |
| virtual | ~KPageWidgetModel() override |
| 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) |
| QModelIndex | index(const KPageWidgetItem *item) const |
| void | insertPage(KPageWidgetItem *before, KPageWidgetItem *item) |
| KPageWidgetItem * | insertPage(KPageWidgetItem *before, QWidget *widget, const QString &name) |
| KPageWidgetItem * | item(const QModelIndex &index) const |
| void | removePage(KPageWidgetItem *item) |
Signals
| void | toggled(KPageWidgetItem *page, bool checked) |
Detailed Description
Member Function Documentation
[explicit] KPageWidgetModel::KPageWidgetModel(QObject *parent = nullptr)
Creates a new page widget model.
parent The parent object.
[override virtual noexcept] KPageWidgetModel::~KPageWidgetModel()
Destroys the page widget model.
void KPageWidgetModel::addPage(KPageWidgetItem *item)
Adds a new top level page to the model.
item The KPageWidgetItem which describes the page.
KPageWidgetItem *KPageWidgetModel::addPage(QWidget *widget, const QString &name)
Adds a new top level page to the model.
widget The widget of the page.
name The name which is displayed in the navigation view.
Returns the associated KPageWidgetItem.
void KPageWidgetModel::addSubPage(KPageWidgetItem *parent, KPageWidgetItem *item)
Inserts a new sub page in the model.
parent The new page will be insert as child of this KPageWidgetItem.
item The KPageWidgetItem which describes the page.
KPageWidgetItem *KPageWidgetModel::addSubPage(KPageWidgetItem *parent, QWidget *widget, const QString &name)
Inserts a new sub page in the model.
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.
QModelIndex KPageWidgetModel::index(const KPageWidgetItem *item) const
Returns the index for a given KPageWidgetItem. The index is invalid if the item can't be found in the model.
void KPageWidgetModel::insertPage(KPageWidgetItem *before, KPageWidgetItem *item)
Inserts a new page in the model.
before The new page will be insert before this KPageWidgetItem on the same level in hierarchy.
item The KPageWidgetItem which describes the page.
KPageWidgetItem *KPageWidgetModel::insertPage(KPageWidgetItem *before, QWidget *widget, const QString &name)
Inserts a new page in the model.
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.
KPageWidgetItem *KPageWidgetModel::item(const QModelIndex &index) const
Returns the KPageWidgetItem for a given index or a null pointer if the index is invalid.
void KPageWidgetModel::removePage(KPageWidgetItem *item)
Removes the page associated with the given KPageWidgetItem.
[signal] void KPageWidgetModel::toggled(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.