Skip to content

Latest commit

 

History

History
56 lines (51 loc) · 1.57 KB

navigation.rst

File metadata and controls

56 lines (51 loc) · 1.57 KB

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).

Object Key Optional? Example
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"]
group <api/groups> Name string Yes
c.group["one"]
c.group
layout <api/layouts> Integer index Yes
c.layout[2]
c.layout
screen <api/screens> Integer index Yes
c.screen[1]
c.screen
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"]
window <api/windows> Integer window ID Yes
c.window[123456]
c.window
core <api/backend> No n/a
c.core