File: navigation.rst

package info (click to toggle)
qtile 0.31.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 5,056 kB
  • sloc: python: 51,342; sh: 262; makefile: 183
file content (56 lines) | stat: -rw-r--r-- 1,609 bytes parent folder | download
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
.. _object_graph_selectors:

Navigating the command graph
============================

As noted previously, some objects require a selector to ensure that the correct
object is selected, while other nodes provide a default object without a selector.

The table below shows what selectors are required for the diferent nodes and whether
the selector is optional (i.e. if it can be omitted to select the default object).

.. list-table::
    :widths: 15 30 15 40
    :header-rows: 1

    * - Object
      - Key
      - Optional?
      - Example
    * - :doc:`bar <api/bars>`
      - | "top", "bottom"
        | (Note: if accessing this node from the root, users on multi-monitor
          setups may wish to navigate via a ``screen`` node to ensure that they
          select the correct object.)
      - No
      - | c.screen.bar["bottom"]
    * - :doc:`group <api/groups>`
      - Name string
      - Yes
      - | c.group["one"]
        | c.group
    * - :doc:`layout <api/layouts>`
      - Integer index
      - Yes
      - | c.layout[2]
        | c.layout
    * - :doc:`screen <api/screens>`
      - Integer index
      - Yes
      - | c.screen[1]
        | c.screen
    * - :doc:`widget <api/widgets>`
      - | Widget name
        | (This is usually the name of the widget class in lower case but can
          be set by passing the ``name`` parameter to the widget.)
      - No
      - | c.widget["textbox"]
    * - :doc:`window <api/windows>`
      - Integer window ID
      - Yes
      - | c.window[123456]
        | c.window
    * - :doc:`core <api/backend>`
      - No
      - n/a
      - | c.core