File: DockManager-spec.txt

package info (click to toggle)
quassel 1%3A0.13.1-1%2Bdeb10u2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 24,888 kB
  • sloc: cpp: 66,948; perl: 15,837; ansic: 4,418; sql: 1,225; sh: 328; xml: 263; python: 224; makefile: 25
file content (74 lines) | stat: -rw-r--r-- 2,078 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
DBus Interface Specification

Docky implements the DockManager specificiation as well as a custom DBus specification.
DockManager DBus Interface Specification

DBus unique path: net.launchpad.DockManager

Object paths:
    /net/launchpad/DockManager

- Interface: net.launchpad.DockManager
  * Methods:
    * GetCapabilities       ()                         -> (Array of [String] capabilities)
    * GetItems              ()                         -> (Array of [Object path])
    * GetItemsByName        (String name               -> (Array of [Object path])
    * GetItemsByDesktopFile (String desktop_file_name) -> (Array of [Object path])
    * GetItemsByPID         (Int32 pid)                -> (Array of [Object path])
    * GetItemByXid          (Int64 xid)                -> (Object path)
  * Signals:
    * ItemAdded             (Object path)
    * ItemRemoved           (Object path)

capabilities:

- dock-item-attention
- dock-item-badge
- dock-item-icon-file
- dock-item-message
- dock-item-progress
- dock-item-tooltip
- dock-item-waiting

- menu-item-container-title
- menu-item-icon-file
- menu-item-icon-name
- menu-item-with-label
- menu-item-with-uri


    /net/launchpad/DockManager/Item[.+] (unspecified identifier)

- Interface: net.launchpad.DockItem
  * Methods:
    * AddMenuItem       (Dict of {String key, Variant value} menu_hints) -> (Int32 id)
    * RemoveMenuItem    (Int32 id)
    * UpdateDockItem    (Dict of {String key, Variant value} hints)
  * Properties (implementing org.freedesktop.DBus.Properties)
    * string DesktopFile
    * string Uri
  * Signals:
    * MenuItemActivated (Int32 id)

Supported menu_hints:

Required:
 - label + String
   OR
 - uri + String
Optional:
 - container-title + String
 - icon-file + String
 - icon-name + String

Implementor can choose whether icon setting will be honored when the menu item is specified using the "uri" key.

Supported hints: All hints are optional.
- attention + Boolean
- badge + String
- icon-file + String
- message + String
- progress + Int
- tooltip + String
- waiting + Boolean