KAbstractConfigModule Class
Base class for QML and QWidgets config modules. More...
| Header: | #include <KAbstractConfigModule> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS KCMUtils)target_link_libraries(mytarget PRIVATE KCMUtilsCore) |
| Since: | 6.0 |
| Inherits: | QObject |
Public Types
Properties
|
|
Public Functions
| KAbstractConfigModule(QObject *parent, const KPluginMetaData &metaData) | |
| QString | authActionName() const |
| KAbstractConfigModule::Buttons | buttons() const |
| virtual void | defaults() |
| bool | defaultsIndicatorsVisible() const |
| QString | description() const |
| virtual void | load() |
| KPluginMetaData | metaData() const |
| QString | name() const |
| bool | needsAuthorization() const |
| bool | needsSave() const |
| bool | representsDefaults() const |
| virtual void | save() |
| void | setAuthActionName(const QString &action) |
| void | setButtons(const KAbstractConfigModule::Buttons btn) |
| void | setDefaultsIndicatorsVisible(bool visible) |
| void | setNeedsSave(bool needs) |
| void | setRepresentsDefaults(bool defaults) |
Signals
| void | activationRequested(const QVariantList &args) |
| void | authActionNameChanged() |
| void | buttonsChanged() |
| void | defaultsIndicatorsVisibleChanged() |
| void | needsSaveChanged() |
| void | representsDefaultsChanged() |
Detailed Description
Member Type Documentation
enum KAbstractConfigModule::Button
flags KAbstractConfigModule::Buttons
An enumeration type for the buttons used by this module.
If Apply is not specified, kcmshell will show a "Close" button.
| Constant | Value | Description |
|---|---|---|
KAbstractConfigModule::NoAdditionalButton | 0 | Shows the "Ok" and "Cancel" buttons. |
KAbstractConfigModule::Help | 1 | Shows a "Help" button. |
KAbstractConfigModule::Default | 2 | Shows a "Use Defaults" button. |
KAbstractConfigModule::Apply | 4 | Shows the "Ok", "Apply", and "Cancel" buttons. |
KAbstractConfigModule::Export | 8 | Obsolete. |
The Buttons type is a typedef for QFlags<Button>. It stores an OR combination of Button values.
See also buttons and setButtons.
Property Documentation
buttons : KAbstractConfigModule::Buttons
Access functions:
| KAbstractConfigModule::Buttons | buttons() const |
| void | setButtons(const KAbstractConfigModule::Buttons btn) |
Notifier signal:
| void | buttonsChanged() |
defaultsIndicatorsVisible : bool
Access functions:
| bool | defaultsIndicatorsVisible() const |
| void | setDefaultsIndicatorsVisible(bool visible) |
Notifier signal:
[read-only] description : const QString
Access functions:
| QString | description() const |
[read-only] name : const QString
Access functions:
| QString | name() const |
[read-only] needsAuthorization : const bool
Access functions:
| bool | needsAuthorization() const |
Notifier signal:
| void | authActionNameChanged() |
needsSave : bool
Access functions:
| bool | needsSave() const |
| void | setNeedsSave(bool needs) |
Notifier signal:
| void | needsSaveChanged() |
representsDefaults : bool
Access functions:
| bool | representsDefaults() const |
| void | setRepresentsDefaults(bool defaults) |
Notifier signal:
| void | representsDefaultsChanged() |
Member Function Documentation
[explicit] KAbstractConfigModule::KAbstractConfigModule(QObject *parent, const KPluginMetaData &metaData)
[signal] void KAbstractConfigModule::activationRequested(const QVariantList &args)
Emitted by a single-instance application (such as System Settings) to request activation and update args to a module that is already running.
The module should connect to this signal when it needs to handle the activation request and specially the new arguments.
args A list of arguments that get passed to the module.
QString KAbstractConfigModule::authActionName() const
Returns the action previously set with setAuthActionName() and that is authorized to execute the save() method.
By default this will be a empty string.
See also setAuthActionName().
[signal] void KAbstractConfigModule::authActionNameChanged()
Emitted when the auth action name has changed.
Note: Notifier signal for property needsAuthorization.
KAbstractConfigModule::Buttons KAbstractConfigModule::buttons() const
Indicate which buttons will be used.
The return value is a value or'ed together from the Button enumeration type.
Note: Getter function for property buttons.
See also setButtons.
[signal] void KAbstractConfigModule::buttonsChanged()
Emitted when the buttons to display have changed.
Note: Notifier signal for property buttons.
[virtual] void KAbstractConfigModule::defaults()
Sets the configuration to default values.
This method is called when the user clicks the "Default" button.
bool KAbstractConfigModule::defaultsIndicatorsVisible() const
Returns the defaultness indicator visibility.
Note: Getter function for property defaultsIndicatorsVisible.
See also setDefaultsIndicatorsVisible().
[signal] void KAbstractConfigModule::defaultsIndicatorsVisibleChanged()
Emitted when the KCM needs to display indicators for field with non default value.
Note: Notifier signal for property defaultsIndicatorsVisible.
QString KAbstractConfigModule::description() const
Returns the description of the config module.
Note: Getter function for property description.
[virtual] void KAbstractConfigModule::load()
Loads the configuration data into the module.
The load method sets the user interface elements of the module to reflect the current settings stored in the configuration files.
This method is invoked whenever the module should read its configuration (most of the times from a config file) and update the user interface. This happens when the user clicks the "Reset" button in the control center, to undo all of his changes and restore the currently valid settings. It is also called right after construction.
KPluginMetaData KAbstractConfigModule::metaData() const
Returns the metaData that was used when instantiating the plugin.
QString KAbstractConfigModule::name() const
Returns the name of the config module.
Note: Getter function for property name.
bool KAbstractConfigModule::needsAuthorization() const
Returns true if the authActionName is not empty.
Note: Getter function for property needsAuthorization.
See also setAuthActionName.
bool KAbstractConfigModule::needsSave() const
Returns true when the module has something changed and needs save.
Note: Getter function for property needsSave.
See also setNeedsSave().
[signal] void KAbstractConfigModule::needsSaveChanged()
Emitted when the state of the modules contents has changed.
This signal is emitted whenever the state of the configuration shown in the module changes. It allows the module container to keep track of unsaved changes.
Note: Notifier signal for property needsSave.
bool KAbstractConfigModule::representsDefaults() const
Returns true when the module state represents the default settings.
Note: Getter function for property representsDefaults.
See also setRepresentsDefaults().
[signal] void KAbstractConfigModule::representsDefaultsChanged()
Emitted when the state of the modules contents has changed in a way that it might represents the defaults settings, or stopped representing them.
Note: Notifier signal for property representsDefaults.
[virtual] void KAbstractConfigModule::save()
The save method stores the config information as shown in the user interface in the config files.
This method is called when the user clicks "Apply" or "Ok".
void KAbstractConfigModule::setAuthActionName(const QString &action)
Set if the module's save() method requires authorization to be executed.
It will still have to execute the action itself using the KAuth library, so this method is not technically needed to perform the action, but using this method will ensure that hosting applications like System Settings or kcmshell behave correctly.
action The action that will be used by this ConfigModule.
See also authActionName().
void KAbstractConfigModule::setButtons(const KAbstractConfigModule::Buttons btn)
Sets the btn to display.
Note: Setter function for property buttons.
See also buttons.
void KAbstractConfigModule::setDefaultsIndicatorsVisible(bool visible)
Changes the defaultness indicator visibility.
visible Whether the indicator should be visible.
Note: Setter function for property defaultsIndicatorsVisible.
See also defaultsIndicatorsVisible().
void KAbstractConfigModule::setNeedsSave(bool needs)
Set this property to true when the user changes something in the module, signaling that it needs a save (such as user pressing Ok or Apply).
Note: Setter function for property needsSave.
See also needsSave().
void KAbstractConfigModule::setRepresentsDefaults(bool defaults)
Set this property to true when the user sets the state of the module to the defaults settings (e.g. clicking Defaults would do nothing).
Note: Setter function for property representsDefaults.
See also representsDefaults().