~ubuntu-branches/ubuntu/utopic/indicator-transfer/utopic

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Ubuntu daily release, Charles Kerr
  • Date: 2014-07-07 22:22:32 UTC
  • mfrom: (1.1.1)
  • Revision ID: package-import@ubuntu.com-20140707222232-ekghznemguwd1wbs
Tags: 0.1+14.10.20140707-0ubuntu1
[ Charles Kerr ]
Create per-transfer actions for simpler state lookup by renderers.
Previously this was done as a single action that contained a map of
unique transfer ids to states.

Show diffs side-by-side

added added

removed removed

Lines of Context:
26
26
   State: None
27
27
   Parameter: None
28
28
 
29
 
 * "transfer-states"
30
 
   Description: The transfers' mutable information; e.g. state and progress
31
 
   State: Dictionary containing key/value pairs of transfer uids strings to
32
 
          a per-transfer dictionary.
33
 
          The inner, per-transfer dictionaries will have key/value pairs for
34
 
           * "percent"      d percent of the progress complete, [0.0 ... 1.0]
35
 
           * "seconds-left" i percent done. NB: Not set if no ETA is available.
36
 
           * "state"        i int value matching the Transfer::State enum
 
29
 * "transfer-state.$UID" (where $UID matches the x-canonical-uid properties)
 
30
   Description: An action whose state provides a transfer's transient properties.
 
31
                This is a dict whose key/value pairs are:
 
32
                * "percent"      d percent of the progress complete, [0.0 ... 1.0]
 
33
                * "seconds-left" i percent done. NB: Not set if no ETA is available.
 
34
                * "state"        i int value matching the Transfer::State enum
 
35
                                   from transfer-indicator/include/transfer/transfer.h
37
36
   Parameter: none. invoking this action has no effect.
38
37
 
39
38
 
52
51
 * Bulk Action Menuitem
53
52
   This behaves like a normal text menuitem but is rendered differently;
54
53
   see the the "Pause all" / "Clear all" buttons in the mockup linked above.
55
 
   - x-canonical-type         s "com.canonical.indicator.transfer-bulk-action"
56
 
   - label                    s label
 
54
   - x-canonical-type         s "com.canonical.indicator.button-section"
 
55
   - label                    s label (e.g., "Successful Transfers")
 
56
   - x-canonical-extra-label  s action label (e.g., "Clear All")
 
57