Differential D8641 Diff 23317 src/formlayoutattached.h

Changeset View

Standalone View

View Options

src/formlayoutattached.h

  • This file was added.
1​/*
2​* Copyright (C) 2017 by Marco Martin <mart@kde.org>
3​*
4​* This program is free software; you can redistribute it and/or modify
5​* it under the terms of the GNU Library General Public License as
6​* published by the Free Software Foundation; either version 2, or
7​* (at your option) any later version.
8​*
9​* This program is distributed in the hope that it will be useful,
10​* but WITHOUT ANY WARRANTY; without even the implied warranty of
11​* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12​* GNU Library General Public License for more details
13​*
14​* You should have received a copy of the GNU Library General Public
15​* License along with this program; if not, write to the
16​* Free Software Foundation, Inc.,
17​* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18​*/
19​
20​#ifndef FORMLAYOUTATTACHED_H
21​#define FORMLAYOUTATTACHED_H
22​
23​#include <QtQml>
24​#include <QObject>
25​
26​class QQuickItem;
27​
28​/**
29​ * This attached property contains the information for decorating a FormLayout:
30​ * It contains the text labels of fields and information about sections.
31​ * @code
32​ * import org.kde.kirigami 2.3 as Kirigami
33​ * Kirigami.FormLayout {
34​ * TextField {
davidedmundsonUnsubmitted
Done

Why would this ever not be the parent? I think having that writable is opening a confusing mess you don't want.

davidedmundson: Why would this ever not be the parent? I think having that writable is opening a confusing mess…
davidedmundsonUnsubmitted
Done

constant

davidedmundson: constant
35​ * Kirigami.FormData.label: "Label:"
36​ * }
37​ * TextField {
38​ * Kirigami.FormData.label: "Label:"
broulikUnsubmitted
Done

nullptr

broulik: `nullptr`
39​ * }
broulikUnsubmitted
Done

override

broulik: `override`
40​ * }
41​ * @endcode
davidedmundsonUnsubmitted
Done

That's a really clever idea; it makes it very flexible so a phone layout could have the labels on top ++++

so I'm a bit surprised that the FormLayout.qml is an object, and not a template; I think it's throwing away an opportunity.

davidedmundson: That's a really clever idea; it makes it very flexible so a phone layout could have the labels…
martAuthorUnsubmitted
Done

at the moment it automatically switches based on the width..
but maybe indeed better to make it a template and force two columns on desktop (on mobile, still automatic i guess, for phone/tablet, or even just portait/landscape phone

mart: at the moment it automatically switches based on the width.. but maybe indeed better to make it…
42​ * @since 2.3
43​ */
44​class FormLayoutAttached : public QObject
45​{
46​ Q_OBJECT
47​ /**
48​ * The label for a form layout field
49​ */
50​ Q_PROPERTY(QString label READ label WRITE setLabel NOTIFY labelChanged)
51​ /**
52​ * If true the FormLayout item is a section separator, a section separator
53​ * may have different looks:
54​ * * To make it just a space between two fields, just put an empty item with isSection:
55​ * @code
56​ * TextField {
57​ * Kirigami.FormData.label: "Label:"
broulikUnsubmitted
Done

Unused, there's also no property.

broulik: Unused, there's also no property.
martAuthorUnsubmitted
Done

other leftovers, sorry :)

mart: other leftovers, sorry :)
58​ * }
broulikUnsubmitted
Done

Also unused

broulik: Also unused
59​ * Item {
60​ * Kirigami.FormData.isSection: true
61​ * }
62​ * TextField {
broulikUnsubmitted
Done

Unused

broulik: Unused
63​ * Kirigami.FormData.label: "Label:"
broulikUnsubmitted
Done

Unused

broulik: Unused
64​ * }
65​ * @endcode
66​ *
67​ * * To make it a space with a section title:
68​ * @code
69​ * TextField {
70​ * Kirigami.FormData.label: "Label:"
71​ * }
72​ * Item {
73​ * Kirigami.FormData.label: "Section Title"
74​ * Kirigami.FormData.isSection: true
75​ * }
76​ * TextField {
77​ * Kirigami.FormData.label: "Label:"
78​ * }
79​ * @endcode
80​ *
81​ * * To make it a space with a section title and a separator line:
82​ * @code
83​ * TextField {
84​ * Kirigami.FormData.label: "Label:"
85​ * }
86​ * Kirigami.Separator {
87​ * Kirigami.FormData.label: "Section Title"
88​ * Kirigami.FormData.isSection: true
89​ * }
90​ * TextField {
91​ * Kirigami.FormData.label: "Label:"
92​ * }
93​ * @endcode
94​ */
95​ Q_PROPERTY(bool isSection READ isSection WRITE setIsSection NOTIFY isSectionChanged)
96​
97​ /**
98​ * The Item the label will be considered a "Buddy" for,
99​ * which will be the parent item the attached property is in.
100​ * A buddy item is useful for instance when the label has a keyboard accelerator,
101​ * which on triggered will be given active keyboard focus to.
102​ */
103​ Q_PROPERTY(QQuickItem *buddyFor READ buddyFor CONSTANT)
104​
105​public:
106​
107​ explicit FormLayoutAttached(QObject *parent = nullptr);
108​ ~FormLayoutAttached() override;
109​
110​ void setLabel(const QString &text);
111​ QString label() const;
112​
113​ QString decoratedLabel() const;
114​
115​ void setIsSection(bool section);
116​ bool isSection() const;
117​
118​ QQuickItem *buddyFor() const;
119​
120​ //QML attached property
121​ static FormLayoutAttached *qmlAttachedProperties(QObject *object);
122​
123​Q_SIGNALS:
124​ void labelChanged();
125​ void isSectionChanged();
126​
127​private:
128​ QString m_label;
129​ QString m_actualDecoratedLabel;
130​ QString m_decoratedLabel;
131​ QPointer <QQuickItem> m_buddyFor;
132​ bool m_isSection = false;
133​};
134​
135​QML_DECLARE_TYPEINFO(FormLayoutAttached, QML_HAS_ATTACHED_PROPERTIES)
136​
137​#endif // FORMLAYOUTATTACHED_H