Differential D21721 Diff 66944 src/qtquick/qml/Button.qml

Changeset View

Standalone View

View Options

src/qtquick/qml/Button.qml

  • This file was added.
1​/*
2​ * Copyright (C) 2019 Dan Leinir Turthra Jensen <admin@leinir.dk>
3​ *
4​ * This library is free software; you can redistribute it and/or
5​ * modify it under the terms of the GNU Lesser General Public
6​ * License as published by the Free Software Foundation; either
7​ * version 2.1 of the License, or (at your option) version 3, or any
8​ * later version accepted by the membership of KDE e.V. (or its
9​ * successor approved by the membership of KDE e.V.), which shall
10​ * act as a proxy defined in Section 6 of version 3 of the license.
11​ *
12​ * This library is distributed in the hope that it will be useful,
13​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​ * Lesser General Public License for more details.
16​ *
17​ * You should have received a copy of the GNU Lesser General Public
18​ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​ *
20​ */
21​
22​/**
23​ * @brief A button which when clicked will open a dialog with a NewStuff.Page at the base
24​ *
25​ * This component is equivalent to the old Button
26​ * @see KNewStuff::Button
27​ * @since 5.63
28​ */
29​
30​import QtQuick 2.11
31​import QtQuick.Controls 2.11 as QtControls
32​
33​import org.kde.newstuff 1.62 as NewStuff
34​
35​QtControls.Button {
36​ id: component
37​
38​ /*
39​ * The configuration file is not aliased, because then we end up initialising the
40​ * KNSCore::Engine immediately the Button is shown, which we want to avoid (as that
ahiemstraUnsubmitted
Done

Any particular reason not to alias these directly to the dialog?

ahiemstra: Any particular reason not to alias these directly to the dialog?
leinirAuthorUnsubmitted
Done

Yes, if it's aliased directly, we end up initialising the engine as soon as the Button component is instantiated, which we want to avoid (as it's quite an expensive operation, and causes internet traffic the user might very well have no intention of using... which arguably is also a phone-home situation, and that needs to be avoided). I'll make an implementationy comment about that. (not really documentation relevant, but certainly relevant when someone invariably comes across this in the future and asks the same question)

leinir: Yes, if it's aliased directly, we end up initialising the engine as soon as the Button…
41​ * is effectively a phone-home scenario, and causes internet traffic in situations
42​ * where it would not seem likely that there should be any).
43​ * If we want, in the future, to add some status display to Button (such as "there
44​ * are updates to be had" or somesuch, then we can do this, but until that choice is
45​ * made, let's not)
46​ */
47​ /**
48​ * The configuration file to use for this button
49​ */
50​ property string configFile: ghnsDialog.configFile
51​
52​ /**
53​ * Set the text that should appear on the button. Will be set as
54​ * i18n("Download New %1").
55​ *
56​ * @note For the sake of consistency, you should NOT override the text propety, just set this one
57​ */
58​ property string downloadNewWhat: i18nc("Used to contruct the button's label (which will become Download New 'this value')", "Stuff")
59​ text: i18n("Download New %1").arg(downloadNewWhat)
60​
61​ /**
62​ * The default view mode of the dialog spawned by this button. This should be
63​ * set using the NewStuff.Page.ViewMode enum
64​ * @see NewStuff.Page.ViewMode
65​ */
66​ property alias viewMode: ghnsDialog.viewMode
67​
68​ /**
69​ * emitted when the Hot New Stuff dialog is about to be shown, usually
70​ * as a result of the user having click on the button
71​ */
72​ signal aboutToShowDialog();
73​
74​ /**
75​ * The engine which handles the content in this Button
76​ */
77​ property alias engine: ghnsDialog.engine
78​
79​ /**
80​ * Contains the entries which have been changed.
81​ * @note This is cleared when the dialog is shown, so the changed entries are those
82​ * changed since the dialog was opened most recently (rather than the lifetime
83​ * of the instance of the Button component)
84​ */
85​ property alias changedEntries: component.engine.changedEntries
86​
87​ /**
88​ * If this is true (default is false), the button will be shown when the Kiosk settings are such
89​ * that Get Hot New Stuff is disallowed (and any other time enabled is set to false).
90​ * Usually you would want to leave this alone, but occasionally you may have a reason to
91​ * leave a button in place that the user is unable to enable.
92​ */
93​ property bool visibleWhenDisabled: false
94​
95​ /**
96​ * Show the dialog (same as clicking the button), if allowed by the Kiosk settings
97​ */
98​ function showDialog() {
99​ if (ghnsDialog.engine.allowedByKiosk) {
100​ ghnsDialog.engine.configFile = component.configFile
101​ component.aboutToShowDialog();
102​ ghnsDialog.open();
103​ } else {
104​ // make some noise, because silently doing nothing is a bit annoying
105​ }
106​ }
107​
108​ onClicked: { showDialog(); }
109​
110​ icon.name: "get-hot-new-stuff"
111​ visible: enabled || visibleWhenDisabled
112​ enabled: ghnsDialog.engine.allowedByKiosk
113​ onEnabledChanged: {
ahiemstraUnsubmitted
Done

Hmm, this is quite tricky, as a user of the Button I can now no longer safely bind enabled as that would override the allowedByKiosk binding. You should probably make this an explicit binding so it doesn't break as easily.

ahiemstra: Hmm, this is quite tricky, as a user of the Button I can now no longer safely bind enabled as…
leinirAuthorUnsubmitted
Not Done

Humhum, yes... so it needs to be possible to change enabled from outside, but it also needs to be locked to disabled if allowedByKiosk is false... i'm thinking this probably won't be the prettiest thing, but... catch enabled changing, check whether allowedByKiosk is false and force it to false in the case it is, and otherwise ignore it... unless there's a magic trick i'm not aware of, which would be neat ;)

leinir: Humhum, yes... so it needs to be possible to change enabled from outside, but it also needs to…
ahiemstraUnsubmitted
Not Done

With a Binding object I can make sure that a button is kept disabled even when the main enabled is bound to a different value. However, I can not prevent javascript "button.enabled = true" from enabling the button, so forcing things in an enabledChanged handler seems the better solution.

ahiemstra: With a Binding object I can make sure that a button is kept disabled even when the main enabled…
114​ // If the user resets this when kiosk has disallowed ghns, force enabled back to false
115​ if (enabled === true && ghnsDialog.engine.allowedByKiosk === false) {
116​ enabled = false;
117​ }
118​ }
119​
120​ NewStuff.Dialog {
121​ id: ghnsDialog
122​ }
123​}