unity-scopes-api

Merge lp:~stolowski/unity-scopes-api/rating-edit-widget-doc into lp:unity-scopes-api/devel

  1. rating-edit-widget-doc
  2. Merge into devel
Proposed by Paweł Stołowski on 2015-05-19
Status: Merged
Approved by: Paweł Stołowski on 2015-05-20
Approved revision: 591
Merged at revision: 591
Proposed branch: lp:~stolowski/unity-scopes-api/rating-edit-widget-doc
Merge into: lp:unity-scopes-api/devel
Diff against target: 41 lines (+24/-0)
1 file modified
src/scopes/PreviewWidget.cpp (+24/-0)
To merge this branch: bzr merge lp:~stolowski/unity-scopes-api/rating-edit-widget-doc
Reviewer Review Type Date Requested Status
PS Jenkins bot continuous-integration Approve on 2015-05-20
Albert Astals Cid (community) 2015-05-19 Approve on 2015-05-19
Unity Team 2015-05-19 Pending
Review via email: mp+259478@code.launchpad.net

Commit Message

Added doc for the new rating-edit widget.

Description of the Change

Added doc for the new rating-edit widget (soon to be landed in unity8).

To post a comment you must log in.
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Albert Astals Cid (aacid) wrote :

Makes sense

review: Approve
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Michi Henning (michihenning) wrote :

As discussed in the stand-up, stating which version of Unity is the one where this can be used would be better. Other than this, it looks great, thanks!

PS Jenkins bot (ps-jenkins) :
review: Approve (continuous-integration)
PS Jenkins bot (ps-jenkins) wrote :

FAILED: Autolanding.
Approved revid is not set in launchpad. This is most likely a launchpad issue and re-approve should fix it. There is also a chance (although a very small one) this is a permission problem of the ps-jenkins bot.
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-autolanding/670/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-amd64-autolanding/97
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-autolanding/96
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-armhf-autolanding/96/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-devel-vivid-i386-autolanding/96

review: Needs Fixing (continuous-integration)
Paweł Stołowski (stolowski) wrote :

> As discussed in the stand-up, stating which version of Unity is the one where
> this can be used would be better. Other than this, it looks great, thanks!

Yes... But as pointed out by Thomas, we have no good version number to give, unfortunately; the version of debian package is pretty much useless for typical developers.

Paweł Stołowski (stolowski) wrote :

Approved before, re-approving to see if jenkins like it now.

PS Jenkins bot (ps-jenkins) :
review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'src/scopes/PreviewWidget.cpp'
2--- src/scopes/PreviewWidget.cpp 2015-02-24 10:45:11 +0000
3+++ src/scopes/PreviewWidget.cpp 2015-05-19 09:20:22 +0000
4@@ -90,6 +90,7 @@
5 \arg \c progress
6 \arg \c text
7 \arg \c rating-input
8+\arg \c rating-edit
9 \arg \c reviews
10 \arg \c expandable
11
12@@ -319,6 +320,29 @@
13 }
14 \endcode
15
16+\subsection rating-edit rating-edit widget
17+
18+The rating-edit widget allows users to edit an existing review and rating. When used in a preview, the widget displays an existing
19+review and a small "pen" icon; user can update the review and/or rating after tapping the "pen" icon.
20+
21+This widget supports all the attributes of rating-input widget, plus three
22+extra attributes (\c "review", \c "rating", \c "author") to pre-fill the widget with data of an existing review.
23+
24+List of attributes:
25+
26+\arg \c rating-label String for the star-based rating (default: "Rate this")
27+\arg \c review-label String for the review input (default: "Add a review")
28+\arg \c submit-label String for the confirmation button (default: "Send")
29+\arg \c rating-icon-empty URI for an empty rating icon
30+\arg \c rating-icon-full URI for a full rating icon
31+\arg \c visible String specifying which of the two widgets are visible (\c "rating", \c "review" or default:\c "both")
32+\arg \c required String specifying which of the two widgets are required to be filled in (\c "rating", \c "review" or default:\c "both")
33+\arg \c author String for the name of the reviewer (optional)
34+\arg \c review String for the text of existing review (optional)
35+\arg \c rating Number for the rating value (optional)
36+
37+Note: The rating-edit widget may not be supported by older versions of unity8 shell.
38+
39 \subsection reviews reviews widget
40
41 The reviews widget is used to display previously-rated content.

Subscribers

People subscribed via source and target branches

to all changes: