← Back to branch summary

~codygarver/+junk/ind-sess

« back to all changes in this revision

Viewing changes to README

  • Committer: Cody Garver
  • Date: 2014-04-03 17:08:08 UTC
  • Revision ID: cody@elementaryos.org-20140403170808-z56s93rorb1dzvmk
Initial import, version 12.10.5+14.04.20140324-0ubuntu1

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
 
1
Indicator-Session is the the session menu indicator for Unity.
 
2
Its behavior and features are listed at https://wiki.ubuntu.com/SystemMenu.
 
3
 
 
4
For instructions on building and running built-in tests, see the INSTALL file.
 
5
 
 
6
 
 
7
Notes for Client Renderers
 
8
--------------------------
 
9
 
 
10
Indicator-Session has two custom menuitems: the Guest and User switchers.
 
11
As per the https://wiki.ubuntu.com/SystemMenu specification, both need four
 
12
visual components: (1) an Active Session Mark, the user's (2) icon, (3) name,
 
13
and (4) a Logged In Mark.
 
14
 
 
15
== User menuitems have "x-canonical-type" set to "indicator.user-menu-item"
 
16
   Their four visual components are determined by:
 
17
 
 
18
   1. You can test for the Action Session Mark by checking the action's state.
 
19
      The state is a dicionary whose "active-user" key yields the current
 
20
      session's owner's username. If it matches the username in this menuitem's
 
21
      "target" attribute, show the Active Session Mark.
 
22
 
 
23
   2. The icon is stored in the menuitem's "icon" attribute. If none is set,
 
24
      the client should use a fallback icon such as "avatar-default."
 
25
 
 
26
   3. The name is stored in the menuitem's "label" attribute.
 
27
 
 
28
   4. You can test for the Logged In Mark by checking the action's state.
 
29
      The state is a dictionary whose "logged-in-users" key will give
 
30
      an array of usernames. If the array contains the username in this
 
31
      menuitem's "target" attribute, show the Logged In Mark.
 
32
 
 
33
== The Guest switcher has "x-canonical-type" set to "indicator.guest-menu-item"
 
34
   action. Its four visual components are determined by:
 
35
 
 
36
   1. You can test for the Active Session Mark by checking the action's state.
 
37
      The state is a dictionary whose "is-active" key yields a boolean.
 
38
      If the boolean is true, show the Active Session Mark.
 
39
 
 
40
   2. The guest user should use a fallback icon such as "avatar-default."
 
41
 
 
42
   3. The name ("Guest") is stored in the menuitem's "label" attribute.
 
43
 
 
44
   4. You can test for the Logged In Mark by checking the action's state.
 
45
      The state is a dictionary whose "is-logged-in" key yields a boolean.
 
46
      If the boolean is true, show the Logged In Mark.
 
47