SettingStateBinding

Search for usage in LXR

SettingStateBinding Class Reference

Inherits Loader.

Properties

alias configObject
 
bool extraEnabledConditions
 
bool nonDefaultHighlightVisible
 
alias settingName
 
Item target
 

Detailed Description

SettingStateBinding automatically impacts the representation of an item based on the state of a setting.

It will disable the item if the setting is immutable and use a visual indicator for the state of the setting.

This is a higher level convenience wrapper for KCMUtils.SettingStateProxy and KCMUtils.SettingStateIndicator.

Since
6.0

Definition at line 20 of file SettingStateBinding.qml.

Property Documentation

◆ configObject

alias SettingStateBinding::configObject
read

configObject: KCoreConfigSkeleton The config object which will be monitored for setting state changes

Definition at line 33 of file SettingStateBinding.qml.

◆ extraEnabledConditions

bool SettingStateBinding::extraEnabledConditions
read

extraEnabledConditions: bool SettingStateBinding will manage the enabled property of the target based on the immutability state of the setting it represents.

But, sometimes that enabled state needs to bind to other properties as well to be computed properly. This extra condition will thus be combined with the immutability state of the setting to determine the effective enabled state of the target.

Definition at line 48 of file SettingStateBinding.qml.

◆ nonDefaultHighlightVisible

bool SettingStateBinding::nonDefaultHighlightVisible
read

nonDefaultHighlightVisible: bool Expose whether the non default highlight is visible.

Allow one to implement highlight with custom items.

Remarks
This property is read-only

Definition at line 55 of file SettingStateBinding.qml.

◆ settingName

alias SettingStateBinding::settingName
read

settingName: string The name of the setting in the config object to be monitored

Definition at line 38 of file SettingStateBinding.qml.

◆ target

Item SettingStateBinding::target
read

target: Item The graphical element whose state we want to manage based on a setting If target is not set, it will try to find the visual parent item

Definition at line 28 of file SettingStateBinding.qml.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:52:14 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.