Merge lp:~stolowski/unity-scopes-api/expandable-attribute into lp:unity-scopes-api/devel

[Paweł Stołowski]

Added doc for the upcoming 'expandable' property of the category renderer definition.

Added doc for the upcoming 'expandable' property of the category renderer definition. The main idea behind this property is to make scopes look better on different form factors, i.e. they can produce some more results than needed and define category to take one or two rows which excess results dropped by the shell (no "Show more" button, just fill given number of rows with results).

Support for this property is implemented through these MRs:
https://code.launchpad.net/~cimi/unity8/dash-forceNotExpandable/+merge/311134
https://code.launchpad.net/~stolowski/unity-scopes-shell/not-expandable/+merge/311173
https://code.launchpad.net/~stolowski/unity-scope-mediascanner/use-no-expandable/+merge/311175 (example use)

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

FAILED: Continuous integration, rev:693
https://jenkins.canonical.com/unity-api-1/job/lp-unity-scopes-api-ci/52/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build/1124/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1131
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/922
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/922/artifact/output/*zip*/output.zip
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=zesty/922/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=xenial+overlay/922
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=xenial+overlay/922/artifact/output/*zip*/output.zip
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=zesty/922/console
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/922
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/922/artifact/output/*zip*/output.zip
    FAILURE: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=zesty/922/console

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

review: Needs Fixing (continuous-integration)

[Marcus Tomlinson (marcustomlinson)]

Hi Pawel, could you consider my slight rewording (in-line).

Also, am I right in understanding that if expandable is false, the number of rows displayed in the fully expanded category will be the value of collapsed-rows? (That's how I worded it as it was a little ambiguous)

review: Needs Fixing

Unmerged revisions

693. By Paweł Stołowski on 2016-11-18

Add expandable attribute doc

=== modified file 'src/scopes/CategoryRenderer.cpp'
--- src/scopes/CategoryRenderer.cpp	2016-06-16 09:27:20 +0000
+++ src/scopes/CategoryRenderer.cpp	2016-11-18 17:00:08 +0000
@@ -67,6 +67,8 @@
 \arg \c card-size Size of the result cards; possible values: \c "small", \c "medium" (default), \c "large"; when using <tt>"category-layout": "vertical-journal"</tt> any integer between 12 and 38
 \arg \c overlay Overlay text data on top of the art; boolean, default false
 \arg \c collapsed-rows Number of result rows displayed while the category is collapsed; possible values: any non-negative integer, where 0 fully expands the category (only affects grid)
+\arg \c expandable Specifies if category should be expandable when collapsed-rows value is other than 0. It's \c true by default. If set to \c false and \c collapsed-rows is non-zero, then "Show more" button
+will not be displayed, the category will be fully expanded and limited to the specified number of rows with as many results as fit displayed (excess results will be dropped).
 \arg \c card-background Background color for the cards; string; URI in the format \verbatim color:///#rrggbb \endverbatim or \verbatim color:///color_name
 \endverbatim or \verbatim gradient:///#rrggbb/#rrggbb \endverbatim or an image URI (will be stretched)
 \arg \c quick-preview-type The type of media content represented by result cards, for use with inline playback; the only currently supported type is "audio".