on xenial help sign in
update doc
commitb6110c285a9ea9f7706cbf1efa1dfd8d6cc2a103 authorMichael Zanetti <michael.zanetti@canonical.com> dateMon 1 Jun 2015, 15:47 (11 years ago) parent5303d17
1 file changed+5−13
qml/Dash/Previews/PreviewCommentInput.qml+5−13
qml/Dash/Previews/PreviewCommentInput.qml+5−13
@@ -18,20 +18,12 @@ import QtQuick 2.0
1818import Ubuntu.Components 0.1
1919import "../../Components"
2020
21−/*! \brief Preview widget for rating.
21+/*! \brief Preview widget for commenting.
2222
23− The widget can show a rating widget and a field to enter a comment.
24− The visibility of the two widgets is specified by widgetData["visible"],
25− accepting "both", "rating" or "review".
26− The requirement of the review is specified by widgetData["visible"],
27− accepting "both", "rating" or "review".
28− It is possible to customise labels, widgetData["rating-label"] for the rating,
29− widgetData["rewiew-label"] for the comment field and widgetData["submit-label"]
30− for the submit button.
31− The icons used in the rating widget can be customised with
32− widgetData["rating-icon-empty"] and widgetData["rating-icon-full"].
33− The successeful submit emits triggered(widgetId, widgetData["required"], data),
34− with data being {"rating": rating value, "review": review comment, "author": null (for now)}.
23+ The widget can show a field to enter a comment.
24+ It is possible to customise the submit button's label by setting widgetData["submit-label"]
25+ The successeful submit emits triggered(widgetId, "commented", data),
26+ with data being {"comment": comment}.
3527*/
3628
3729PreviewWidget {