Merge lp:~alecu/unity-scopes-api/table-widget-docs into lp:unity-scopes-api

[Alejandro J. Cura]

Add docs for the table widget

[Michi Henning (michihenning)]

Thanks for that! Looks good, but I would reword one sentence:

> \arg \c values An array with as many entries as rows desired. Each entry is an array of two strings: label and value

It'll read better as:

\arg \c values An array with one element per row. Each entry is an array of two strings: label and value.

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:276
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/511/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/36/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/36/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/36/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/511/rebuild

review: Needs Fixing (continuous-integration)

[Michi Henning (michihenning)]

Apologies for this failure, it is caused by a change in json-cpp. You can get rid of the failure by merging this branch: https://code.launchpad.net/~marcustomlinson/unity-scopes-api/lp-1410125/+merge/246264

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:277
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/515/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/40/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/40/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/40/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/515/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:277
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/529/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/54
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/54
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/54/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/54

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/529/rebuild

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

Looks good, thanks!

review: Approve

[Michi Henning (michihenning)]

I just noticed that this has been sitting here for a long time. Is there any reason we can't merge it?

[Albert Astals Cid (aacid)]

Looks good to me, one thing that would be good to include is that when the table is inside a non expanded Expandable only 3 rows at most are shown.

review: Needs Fixing

[lp:~alecu/unity-scopes-api/table-widget-docs]

278. By Alejandro J. Cura on 2015-09-04

When used inside an Expandable widget, the topmost 3 rows are shown until it's expanded.

[Alejandro J. Cura (alecu)]

I've added a line explaining what happens when used inside an Expandable widget.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:278
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/634/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-amd64-ci/22
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-armhf-ci/22
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-armhf-ci/22/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-wily-i386-ci/22

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/634/rebuild

review: Approve (continuous-integration)

[Michi Henning (michihenning)]

Albert, if you are happy with this, can you top-approve please?

review: Approve

[Albert Astals Cid (aacid)]

review: Approve

=== modified file 'src/scopes/PreviewWidget.cpp'
--- src/scopes/PreviewWidget.cpp	2015-08-13 09:16:59 +0000
+++ src/scopes/PreviewWidget.cpp	2015-09-04 18:06:51 +0000
@@ -96,6 +96,7 @@
 \arg \c comment-input
 \arg \c comment
 \arg \c expandable
+\arg \c table
 
 \subsection audio audio widget
 
@@ -448,6 +449,29 @@
     expandable.add_widget(w2);
     ...
 \endcode
+
+\subsection table table widget
+
+The table widget is used to show a table with labels and values.
+When used inside an Expandable widget, the topmost 3 rows are shown until it's expanded.
+
+List of attributes:
+\arg \c title A string specifying the title to be shown on top
+\arg \c values An array with one element per row. Each element is an array of two strings: label and value
+
+\code
+    PreviewWidget table("details", "table");
+    table.add_attribute_value("title", Variant("This is a table widget"));
+
+    VariantArray values {
+        Variant{VariantArray{Variant{_("Version number")}, Variant{"0.83b"}}},
+        Variant{VariantArray{Variant{_("Last updated")}, Variant{"2015-01-15"}}},
+        Variant{VariantArray{Variant{_("First released")}, Variant{"2013-12-16"}}},
+        Variant{VariantArray{Variant{_("Size")}, Variant{"11.3 MiB"}}},
+    };
+    table.add_attribute_value("values", Variant(values));
+    ...
+\endcode
 */
 
 //! @cond