Merge lp:~stolowski/unity-scopes-api/new-widgets-doc-wily into lp:unity-scopes-api/devel

[Paweł Stołowski]

Added doc for comment, comment-input and icon-actions widgets

Added doc for comment, comment-input and icon-actions widgets.

[Albert Astals Cid (aacid)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:621
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-ci/1502/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-amd64-ci/43/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-armhf-ci/43/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-i386-ci/43/console

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

review: Needs Fixing (continuous-integration)

[Andrea Cimitan (cimi)]

review: Needs Information

[Paweł Stołowski (stolowski)]

See my reply below.

[Andrea Cimitan (cimi)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-autolanding/698/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-amd64-autolanding/26/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-armhf-autolanding/26/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-i386-autolanding/26/console

review: Needs Fixing (continuous-integration)

[Michi Henning (michihenning)]

Looks good, thanks!

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-autolanding/699/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-amd64-autolanding/27/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-armhf-autolanding/27/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-wily-i386-autolanding/27/console

review: Needs Fixing (continuous-integration)

[lp:~stolowski/unity-scopes-api/new-widgets-doc-wily]

622. By Paweł Stołowski on 2015-08-20

Merged devel

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

=== modified file 'src/scopes/PreviewWidget.cpp'
--- src/scopes/PreviewWidget.cpp	2015-05-19 09:19:13 +0000
+++ src/scopes/PreviewWidget.cpp	2015-08-20 14:48:09 +0000
@@ -87,11 +87,14 @@
 \arg \c gallery
 \arg \c header
 \arg \c actions
+\arg \c icon-actions
 \arg \c progress
 \arg \c text
 \arg \c rating-input
 \arg \c rating-edit
 \arg \c reviews
+\arg \c comment-input
+\arg \c comment
 \arg \c expandable
 
 \subsection audio audio widget
@@ -242,6 +245,17 @@
 }
 \endcode
 
+\subsection icon-actions icon-actions widget
+
+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.
+Every button can provide an optional temporary icon to be displayed immediately after user taps it.
+
+List of attributes:
+
+\arg \c actions A composite attribute containing an array of tuples, where each tuple has at least
+these fields: \c id (a mandatory string that is passed to unity::scopes::ScopeBase::activate_preview_action()),
+\c label (optional string), \c icon (optional URI, required if label is missing), \c temporaryIcon (optional URI).
+
 \subsection progress progress widget
 
 The progress widget displays the progress of an action, such as download progress.
@@ -378,6 +392,39 @@
 }
 \endcode
 
+\subsection comment-input comment-input widget
+
+The comment-input widget allows users to add comments. It displays an input box along with "Send" button.
+
+When a user presses the "Send" button, the scope receives a preview
+action activation with the id \c "commented".  The actual comment
+can be accessed via unity::scopes::ActionMetadata::scope_data.
+The scope data will be a VariantMap with the \c "comment" field holding
+the text entered by the user.
+
+List of attributes:
+
+\arg \c submit-label String for the label of the submit button (optional, uses "Submit" by default).
+
+\code{.cpp}
+{
+    PreviewWidget w1("cmt", "comment-input");
+
+    w1.add_attribute_value("submit-label", Variant("Comment it!"));
+    ...
+}
+\endcode
+
+\subsection comment comment widget
+
+The comment widget shows an avatar, author name, subtitle and a comment text.
+
+List of attributes:
+\arg \c source URI for an avatar icon (optional)
+\arg \c author A string specifying the author of the comment (mandatory)
+\arg \c subtitle A string for the subtitle (optional)
+\arg \c comment A string for the comment text (mandatory)
+
 \subsection expandable expandable widget
 
 The expandable widget is used to group several widgets into an expandable pane.