File tree Expand file tree Collapse file tree 2 files changed +11
-7
lines changed Expand file tree Collapse file tree 2 files changed +11
-7
lines changed Original file line number Diff line number Diff line change 11.. _api :
22
3- ====================
4- Python API Reference
5- ====================
3+ ===================
4+ tmuxp API Reference
5+ ===================
66
77.. module :: tmuxp
88
Original file line number Diff line number Diff line change 44Internals
55=========
66
7+ .. seealso :: :ref:`api`
8+
79.. module :: tmuxp
810
911tmuxp is an `abstraction layer ` against tmux' command line arguments.
1012
11- tmuxp is an ` ORM ` in the sense bases of :class: `util.TmuxObject `, such as
12- :class: `Server `, :class: `Session `, :class: `Window ` and :class: ` Pane `
13- are stateful objects and related to their parent or child .
13+ :class: `util.TmuxRelationalObject ` acts as a container to connect the
14+ relations of :class: `Server `, :class: `Session `, :class: `Window ` and
15+ :class: ` Pane ` .
1416
1517======================== ======================= =========================
1618Object Child Parent
@@ -29,7 +31,9 @@ A server can have multiple sessions. ``Ctrl-a s`` can be used to switch
2931between sessions running on the server.
3032
3133Sessions, Windows and Panes all have their own unique identifier for
32- internal purposes.
34+ internal purposes. :class: `util.TmuxMappingObject ` will make use of the
35+ unique identifiers (``session_id ``, ``window_id ``, ``pane_id `` ) to look
36+ up the data stored in the :class: `Server ` object.
3337
3438======================== ======================= =========================
3539Object Prefix Example
You can’t perform that action at this time.
0 commit comments