Differential D27840 Diff 78698 src/qmlcontrols/kcmcontrols/qml/SettingStateBinding.qml

Changeset View

Standalone View

View Options

src/qmlcontrols/kcmcontrols/qml/SettingStateBinding.qml

  • This file was added.
1​/*
2​ Copyright (c) 2020 Kevin Ottens <kevin.ottens@enioka.com>
3​
4​ This library is free software; you can redistribute it and/or
5​ modify it under the terms of the GNU Library General Public
6​ License version 2 as published by the Free Software Foundation.
7​
8​ This library is distributed in the hope that it will be useful,
9​ but WITHOUT ANY WARRANTY; without even the implied warranty of
10​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11​ Library General Public License for more details.
12​
13​ You should have received a copy of the GNU Library General Public License
14​ along with this library; see the file COPYING.LIB. If not, write to
15​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
16​ Boston, MA 02110-1301, USA.
17​*/
18​
19​import QtQuick 2.8
20​import QtQuick.Layouts 1.3
21​import org.kde.kcm 1.3 as KCM
22​import org.kde.kcm.private 1.3
23​
24​/**
25​ * SettingStateBinding automatically impacts the representation
26​ * of an item based on the state of a setting. It will disable
27​ * the item if the setting is immutable and use a visual indicator
28​ * for the state of the setting.
29​ *
30​ * This is a higher level convenience wrapper for KCM.SettingStateProxy
31​ * and KCM.SettingStateIndicator.
32​ *
33​ * @since 5.69
34​ */
35​Item {
36​ id: root
37​
38​ /**
39​ * target: Item
40​ * The graphical element whose state we want to manage based on a setting
41​ */
broulikUnsubmitted
Done

*whose

broulik: *whose
42​ property Item target
43​
44​ /**
45​ * configObject: KCoreConfigSkeleton
46​ * The config object which will be monitored for setting state changes
47​ */
48​ property alias configObject: settingState.configObject
49​
50​ /**
51​ * itemName: string
52​ * The name of the item representing the setting in the config object
53​ */
54​ property alias itemName: settingState.itemName
55​
56​ /**
57​ * extraEnabledPredicate: bool
58​ * SettingStateBinding will manage the enabled property of the target
59​ * based on the immutability state of the setting it represents. But,
broulikUnsubmitted
Done

This description didn't really help me in understanding what it does until I read the code further down.

broulik: This description didn't really help me in understanding what it does until I read the code…
ervinAuthorUnsubmitted
Not Done

Went for something much more verbose, but at least it says what it does.

ervin: Went for something much more verbose, but at least it says what it does.
60​ * sometimes that enabled state needs to bind to other properties as
61​ * well to be computed properly. This extra predicate will thus be
62​ * combined with the immutability state of the setting to determine
63​ * the effective enabled state of the target.
64​ */
65​ property bool extraEnabledPredicate: true
66​
67​ /**
68​ * indicatorAsOverlay: bool
69​ * If true the state indicator will be displayed inside the boundaries
70​ * of the target item which is convenient for items with lots of empty
71​ * space like list or grid views (default is false)
72​ */
73​ property bool indicatorAsOverlay: false
74​
75​
76​ QtObject {
broulikUnsubmitted
Done

Can you explain this.
Can't you

indicatorComponent.createObject(target, {
    settingsState: settingsState
});
broulik: Can you explain this. Can't you ``` indicatorComponent.createObject(target, { settingsState…
ervinAuthorUnsubmitted
Not Done

Good point.

ervin: Good point.
77​ id: impl
78​ property KCM.SettingStateIndicator indicator: null
79​ }
80​
81​ onTargetChanged: {
82​ if (impl.indicator) {
83​ impl.indicator.destroy()
84​ impl.indicator = null
85​ }
86​
87​ if (target) {
88​ impl.indicator = indicatorComponent.createObject(target, {
89​ settingState: settingState
90​ })
91​ }
92​ }
broulikUnsubmitted
Done

We could also bind parent: target instead?

broulik: We could also bind `parent: target` instead?
ervinAuthorUnsubmitted
Not Done

Tried it and QQuickItem was very angry at me, I didn't push further. :-)

ervin: Tried it and QQuickItem was very angry at me, I didn't push further. :-)
93​
94​ // We use it via a Component because we potentially need
95​ // to escape the parent/siblings only constraint for anchoring
96​ // (since we anchor to root.target which could be anywhere)
97​ Component {
98​ id: indicatorComponent
broulikUnsubmitted
Done

Please check if this works with right-to-left languages (run with -reverse argument to test)

broulik: Please check if this works with right-to-left languages (run with `-reverse` argument to test)
ervinAuthorUnsubmitted
Not Done

Again that's one of those comments I'd have appreciated on the widgets version a little while ago. ;-)

ervin: Again that's one of those comments I'd have appreciated on the widgets version a little while…
99​ KCM.SettingStateIndicator {
broulikUnsubmitted
Done

Always Math.round whenever you divide sizes to ensure integer alignment

broulik: Always `Math.round` whenever you divide sizes to ensure integer alignment
100​ readonly property real directionFactor: (Qt.application.layoutDirection === Qt.LeftToRight ? 1 : -1)
101​ x: helper.leftCoord - (root.indicatorAsOverlay ? width : 0) * directionFactor
102​ y: root.indicatorAsOverlay ? 0 : Math.round((parent.height - height) / 2)
103​ settingState: impl.settingState
104​ }
105​ }
106​
107​ Binding {
108​ target: root.target
109​ property: "enabled"
110​ value: extraEnabledPredicate && !settingState.immutable
111​ }
112​
113​ KCM.SettingStateProxy {
114​ id: settingState
115​ }
116​
117​ SettingStateBindingPrivate {
118​ id: helper
119​ target: root.target
120​ indicator: impl.indicator
121​ }
122​}