ConfigurationView
Properties | |
list< ConfigurationModule > | modules |
string | title |
KirigamiApplicationWindow | window |
Public Member Functions | |
void | open (defaultModule='') |
Detailed Description
This is an abstract view to display the configuration of an application.
The various configuration modules can be defined by providing ConfigurationModule to the modules property.
On desktop, this will display the modules in a list view and displaying the actual page next to it. On mobile, only the list of modules will be initially displayed.
This will result in the following dialog on desktop.
On the following page on mobile.
- Since
- KirigamiAddons 1.3.0
Definition at line 71 of file ConfigurationView.qml.
Property Documentation
◆ modules
|
read |
This property holds the list of pages for the settings.
Definition at line 82 of file ConfigurationView.qml.
◆ title
|
read |
This property holds the title of the config view.
By default this is "Settings"
Definition at line 78 of file ConfigurationView.qml.
◆ window
|
read |
This property holds the parent window.
This needs to be set before calling open.
Definition at line 88 of file ConfigurationView.qml.
Member Function Documentation
◆ open()
void ConfigurationView::open | ( | defaultModule | = '' | ) |
Open the configuration window.
@params defaultModule The moduleId of the default configuration that should be preselected when opening the configuration view. By default is not specified, this will choose the first module.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:03:50 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.