dev-notes/DockManager-spec.txt

   1 DBus Interface Specification
   2
   3 Docky implements the DockManager specificiation as well as a custom DBus specification.
   4 DockManager DBus Interface Specification
   5
   6 DBus unique path: net.launchpad.DockManager
   7
   8 Object paths:
   9     /net/launchpad/DockManager
  10
  11 - Interface: net.launchpad.DockManager
  12   * Methods:
  13     * GetCapabilities       ()                         -> (Array of [String] capabilities)
  14     * GetItems              ()                         -> (Array of [Object path])
  15     * GetItemsByName        (String name               -> (Array of [Object path])
  16     * GetItemsByDesktopFile (String desktop_file_name) -> (Array of [Object path])
  17     * GetItemsByPID         (Int32 pid)                -> (Array of [Object path])
  18     * GetItemByXid          (Int64 xid)                -> (Object path)
  19   * Signals:
  20     * ItemAdded             (Object path)
  21     * ItemRemoved           (Object path)
  22
  23 capabilities:
  24
  25 - dock-item-attention
  26 - dock-item-badge
  27 - dock-item-icon-file
  28 - dock-item-message
  29 - dock-item-progress
  30 - dock-item-tooltip
  31 - dock-item-waiting
  32
  33 - menu-item-container-title
  34 - menu-item-icon-file
  35 - menu-item-icon-name
  36 - menu-item-with-label
  37 - menu-item-with-uri
  38
  39
  40     /net/launchpad/DockManager/Item[.+] (unspecified identifier)
  41
  42 - Interface: net.launchpad.DockItem
  43   * Methods:
  44     * AddMenuItem       (Dict of {String key, Variant value} menu_hints) -> (Int32 id)
  45     * RemoveMenuItem    (Int32 id)
  46     * UpdateDockItem    (Dict of {String key, Variant value} hints)
  47   * Properties (implementing org.freedesktop.DBus.Properties)
  48     * string DesktopFile
  49     * string Uri
  50   * Signals:
  51     * MenuItemActivated (Int32 id)
  52
  53 Supported menu_hints:
  54
  55 Required:
  56  - label + String
  57    OR
  58  - uri + String
  59 Optional:
  60  - container-title + String
  61  - icon-file + String
  62  - icon-name + String
  63
  64 Implementor can choose whether icon setting will be honored when the menu item is specified using the "uri" key.
  65
  66 Supported hints: All hints are optional.
  67 - attention + Boolean
  68 - badge + String
  69 - icon-file + String
  70 - message + String
  71 - progress + Int
  72 - tooltip + String
  73 - waiting + Boolean
  74