1
=== modified file 'src/scopes/PreviewWidget.cpp'
2
--- src/scopes/PreviewWidget.cpp	2015-05-19 09:19:13 +0000
3
+++ src/scopes/PreviewWidget.cpp	2015-08-20 14:48:09 +0000
4
@@ -87,11 +87,14 @@
5
87
\arg \c gallery
87
\arg \c gallery
6
88
\arg \c header
88
\arg \c header
7
89
\arg \c actions
89
\arg \c actions
8
90
\arg \c icon-actions
9
90
\arg \c progress
91
\arg \c progress
10
91
\arg \c text
92
\arg \c text
11
92
\arg \c rating-input
93
\arg \c rating-input
12
93
\arg \c rating-edit
94
\arg \c rating-edit
13
94
\arg \c reviews
95
\arg \c reviews
14
96
\arg \c comment-input
15
97
\arg \c comment
16
95
\arg \c expandable
98
\arg \c expandable
17
96
99
18
97
\subsection audio audio widget
100
\subsection audio audio widget
19
@@ -242,6 +245,17 @@
20
242
}
245
}
21
243
\endcode
246
\endcode
22
244
247
23
248
\subsection icon-actions icon-actions widget
24
249
25
250
The icon-actions widget displays one or more buttons represented by icons and/or labels. It's similar to actions widget, but uses different layout.
26
251
Every button can provide an optional temporary icon to be displayed immediately after user taps it.
27
252
28
253
List of attributes:
29
254
30
255
\arg \c actions A composite attribute containing an array of tuples, where each tuple has at least
31
256
these fields: \c id (a mandatory string that is passed to unity::scopes::ScopeBase::activate_preview_action()),
32
257
\c label (optional string), \c icon (optional URI, required if label is missing), \c temporaryIcon (optional URI).
33
258
34
245
\subsection progress progress widget
259
\subsection progress progress widget
35
246
260
36
247
The progress widget displays the progress of an action, such as download progress.
261
The progress widget displays the progress of an action, such as download progress.
37
@@ -378,6 +392,39 @@
38
378
}
392
}
39
379
\endcode
393
\endcode
40
380
394
41
395
\subsection comment-input comment-input widget
42
396
43
397
The comment-input widget allows users to add comments. It displays an input box along with "Send" button.
44
398
45
399
When a user presses the "Send" button, the scope receives a preview
46
400
action activation with the id \c "commented".  The actual comment
47
401
can be accessed via unity::scopes::ActionMetadata::scope_data.
48
402
The scope data will be a VariantMap with the \c "comment" field holding
49
403
the text entered by the user.
50
404
51
405
List of attributes:
52
406
53
407
\arg \c submit-label String for the label of the submit button (optional, uses "Submit" by default).
54
408
55
409
\code{.cpp}
56
410
{
57
411
    PreviewWidget w1("cmt", "comment-input");
58
412
59
413
    w1.add_attribute_value("submit-label", Variant("Comment it!"));
60
414
    ...
61
415
}
62
416
\endcode
63
417
64
418
\subsection comment comment widget
65
419
66
420
The comment widget shows an avatar, author name, subtitle and a comment text.
67
421
68
422
List of attributes:
69
423
\arg \c source URI for an avatar icon (optional)
70
424
\arg \c author A string specifying the author of the comment (mandatory)
71
425
\arg \c subtitle A string for the subtitle (optional)
72
426
\arg \c comment A string for the comment text (mandatory)
73
427
74
381
\subsection expandable expandable widget
428
\subsection expandable expandable widget
75
382
429
76
383
The expandable widget is used to group several widgets into an expandable pane.
430
The expandable widget is used to group several widgets into an expandable pane.
Status:	Merged
Approved by:	Michi Henning on 2015-08-24
Approved revision:	622
Merged at revision:	623
Proposed branch:	lp:~stolowski/unity-scopes-api/new-widgets-doc-wily
Merge into:	lp:unity-scopes-api/devel
Diff against target:	76 lines (+47/-0) 1 file modified src/scopes/PreviewWidget.cpp (+47/-0)
To merge this branch:	bzr merge lp:~stolowski/unity-scopes-api/new-widgets-doc-wily
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
PS Jenkins bot (community)	continuous-integration		Approve on 2015-08-20
Michi Henning (community)		2015-08-13	Approve on 2015-08-17
Andrea Cimitan (community)		2015-08-13	Approve on 2015-08-13
Albert Astals Cid (community)		2015-08-13	Approve on 2015-08-13
Review via email: mp+267921@code.launchpad.net