1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
/*
* Copyright 2012 Canonical Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import QtQuick 2.0
import Ubuntu.Components 1.1
import Ubuntu.Components.ListItems 1.0
/*!
\qmltype Standard
\inqmlmodule Ubuntu.Components.ListItems 1.0
\ingroup ubuntu-listitems
\brief The standard list item class. It shows a basic list item
with a label (text), and optionally an icon, a progression arrow,
and it can have an embedded Item (\l control) that can be used
for including Buttons, Switches etc. inside the list item.
\l {http://design.ubuntu.com/apps/building-blocks/list-items}{See also the Design Guidelines on List Items}.
Examples:
\qml
import Ubuntu.Components 1.1
import Ubuntu.Components.ListItems 1.0 as ListItem
Column {
ListItem.Standard {
text: "Selectable standard list item"
selected: false
onClicked: selected = !selected
}
ListItem.Standard {
text: "List item with icon"
iconName: "compose"
}
ListItem.Standard {
text: "With a progression arrow"
progression: true
}
ListItem.Standard {
text: "Control"
control: Button {
text: "Click me"
width: units.gu(19)
onClicked: print("Clicked")
}
progression: true
}
}
\endqml
\b{This component is under heavy development.}
*/
Empty {
id: listItem
/*!
\deprecated
\b{Use iconName or iconSource instead.}
The location of the icon to show in the list item (optional), or an Item that is
shown on the left side inside the list item. The icon will automatically be
anchored to the left side of the list item, and if its height is undefined, to the top
and bottom of the list item.
\qmlproperty variant icon
*/
property variant icon: iconSource != "" ? iconSource : undefined
/*!
\preliminary
The location of the icon to show in the list item if iconSource failed to load (optional).
\qmlproperty url fallbackIconSource
*/
property alias fallbackIconSource: iconHelper.fallbackSource
/*!
The icon shown in the list item if iconName failed to load (optional).
\qmlproperty string fallbackIconName
If both fallbackIconSource and fallbackIconName are defined, fallbackIconName will be ignored.
\note The complete list of icons available in Ubuntu is not published yet.
For now please refer to the folders where the icon themes are installed:
\list
\li Ubuntu Touch: \l file:/usr/share/icons/suru
\li Ubuntu Desktop: \l file:/usr/share/icons/ubuntu-mono-dark
\endlist
These 2 separate icon themes will be merged soon.
*/
property alias fallbackIconName: iconHelper.fallbackIconName
/*!
\preliminary
The text that is shown in the list item as a label.
\qmlproperty string text
*/
/*!
\preliminary
Show or hide the progression symbol.
*/
property bool progression: false
/*!
\internal
\deprecated
Width of the icon to be displayed
*/
property real __iconWidth
/*!
\internal
\deprecated
Height of the icon to be displayed
*/
property real __iconHeight
/*!
\internal
\deprecated
The margins on the left side of the icon.
*/
property real __leftIconMargin
/*!
\internal
\deprecated
The margins on the right side of the icon.
*/
property real __rightIconMargin
/*!
\preliminary
An optional control that is displayed inside the list item.
The width of the control must be specified in order to determine
the layout of the list item.
\qmlproperty Item control
*/
property alias control: controlContainer.control
/*!
\preliminary
Show or hide the frame around the icon
\qmlproperty bool iconFrame
*/
property alias iconFrame: iconHelper.hasFrame
// If there is a control, the controlArea covers the listItem's mouseArea,
// so in that case use the highlights below when pressed
highlightWhenPressed: !listItem.control
// Avoid emit clicked signals when clicking on the control area
__acceptEvents: false
/*!
\internal
*/
property bool __controlAreaPressed: false
Rectangle {
id: controlHighlight
visible: listItem.swipingState === "" ? control && __controlAreaPressed : false
anchors {
top: parent.top
right: progressionHelper.visible ? progressionHelper.left : parent.right
bottom: parent.bottom
left: parent.left
}
color: Theme.palette.selected.background
}
Rectangle {
id: progressionHighlight
visible: listItem.swipingState === "" ? listItem.progression && progressionHelper.showSplit && listItem.pressed && !__controlAreaPressed : false
anchors {
left: progressionHelper.left
top: parent.top
bottom: parent.bottom
right: parent.right
}
color: Theme.palette.selected.background
}
IconVisual {
id: iconHelper
width: height
height: Math.min(units.gu(5), parent.height - units.gu(1))
anchors {
left: parent.left
leftMargin: listItem.__contentsMargins
verticalCenter: parent.verticalCenter
}
}
/*!
\internal
The \l icon property is an Item. The value is false if \l icon is a string,
or when no icon was set.
*/
property bool __iconIsItem: false
/*!
\internal
*/
onIconChanged: {
if (icon == undefined) return;
if (icon != iconSource) {
console.warn("WARNING: ListItems.Standard.icon is DEPRECATED. " +
"Use iconName and iconSource instead.")
}
if (typeof icon == "string" || typeof icon == typeof iconSource) {
// icon is the url of an image
iconHelper.source = icon;
__iconIsItem = false;
} else {
// icon is an Item.
__iconIsItem = true;
iconHelper.source = "";
icon.parent = listItem;
icon.anchors.left = listItem.left;
icon.anchors.margins = Qt.binding(function() { return listItem.__contentsMargins });
if (!icon.height) {
icon.anchors.top = listItem.top;
icon.anchors.bottom = listItem.bottom;
}
}
}
/*!
\internal
The \l foregroundGroundColor property stores the internal label color.
*/
property alias __foregroundColor: label.color
LabelVisual {
id: label
property bool anchorToIconHelper: !__iconIsItem && iconHelper.source != ""
selected: listItem.selected
anchors {
verticalCenter: parent.verticalCenter
left: anchorToIconHelper ? iconHelper.right : parent.left
leftMargin: __iconIsItem ? icon.width + 2 * listItem.__contentsMargins : listItem.__contentsMargins
right: control ? controlContainer.left : (progression ? progressionHelper.left : parent.right)
rightMargin: listItem.__contentsMargins
}
text: listItem.text
}
Item {
id: controlContainer
property Item control
// use the width of the control if there is (possibly elided) text,
// or full width available if there is no text.
width: control ? control.width : undefined
height: control ? control.height : undefined
anchors {
right: listItem.progression ? progressionHelper.left : parent.right
rightMargin: listItem.__contentsMargins
verticalCenter: parent.verticalCenter
}
onControlChanged: {
if (control) control.parent = controlContainer;
}
Connections {
target: listItem.__mouseArea
onClicked: {
if (control && __mouseArea.mouseX < progressionHelper.x) {
if (control.enabled && control.hasOwnProperty("clicked")) control.clicked();
} else {
listItem.clicked();
}
}
onPressAndHold: {
if (control && control.enabled && __mouseArea.mouseX < progressionHelper.x && control.hasOwnProperty("pressAndHold")) {
control.pressAndHold();
} else {
listItem.pressAndHold();
}
}
}
}
/*!
\internal
*/
onPressedChanged: {
if (listItem.pressed && control && control.enabled && (__mouseArea.mouseX < progressionHelper.x)) {
listItem.__controlAreaPressed = true
} else {
listItem.__controlAreaPressed = false
}
}
ProgressionVisual {
id: progressionHelper
visible: listItem.progression
anchors {
right: parent.right
rightMargin: listItem.__contentsMargins
top: parent.top
bottom: parent.bottom
}
showSplit: control ? true : false
splitMargin: listItem.__contentsMargins
}
}
|