Merge lp:~stolowski/unity-scopes-api/fix-expandable-widget-doc into lp:unity-scopes-api/devel

[Paweł Stołowski]

Updated the docs for expandable preview widget.

Updated the docs for expandable preview widget per Albert's suggestion to the bug report.

[unity-api-1-bot (unity-api-1-bot)]

FAILED: Continuous integration, rev:678
https://jenkins.canonical.com/unity-api-1/job/lp-unity-scopes-api-ci/28/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/79/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/86
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-1-sourcepkg/release=vivid+overlay/58/console
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-1-sourcepkg/release=xenial/58/console

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-unity-scopes-api-ci/28/rebuild

review: Needs Fixing (continuous-integration)

[Albert Astals Cid (aacid)]

Looks good to me

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'src/scopes/PreviewWidget.cpp'
--- src/scopes/PreviewWidget.cpp	2016-01-18 19:50:19 +0000
+++ src/scopes/PreviewWidget.cpp	2016-06-14 15:57:13 +0000
@@ -431,15 +431,18 @@
 \subsection expandable expandable widget
 
 The expandable widget is used to group several widgets into an expandable pane.
+The expandable widget can be collapsed or uncollapsed. When it's uncollapsed then
+all the contained widgets are shown. When collapsed, only the first few widgets determined
+by collapsed-widgets attribute are shown.
 
 List of attributes:
 \arg \c title A string specifying the title
-\arg \c collapsed-widgets Optional number of collapsed widgets (0 makes all of them visible)
+\arg \c collapsed-widgets A number of widgets to show when the expandable widget is collapsed (optional).
 
 \code
     PreviewWidget expandable("exp", "expandable");
     expandable.add_attribute_value("title", Variant("This is an expandable widget"));
-    expandable.add_attribute_value("collapsed-widgets", Variant(0));
+    expandable.add_attribute_value("collapsed-widgets", Variant(2));
 
     PreviewWidget w1("w1", "text");
     w1.add_attribute_value("title", Variant("Subwidget 1"));
@@ -447,8 +450,12 @@
     PreviewWidget w2("w2", "text");
     w2.add_attribute_value("title", Variant("Subwidget 2"));
     w2.add_attribute_value("text", Variant("A text"));
+    PreviewWidget w3("w3", "text");
+    w3.add_attribute_value("title", Variant("Subwidget 3"));
+    w3.add_attribute_value("text", Variant("A text"));
     expandable.add_widget(w1);
     expandable.add_widget(w2);
+    expandable.add_widget(w3);
     ...
 \endcode