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 1
1
.. _api :
2
2
3
- ====================
4
- Python API Reference
5
- ====================
3
+ ===================
4
+ tmuxp API Reference
5
+ ===================
6
6
7
7
.. module :: tmuxp
8
8
Original file line number Diff line number Diff line change 4
4
Internals
5
5
=========
6
6
7
+ .. seealso :: :ref:`api`
8
+
7
9
.. module :: tmuxp
8
10
9
11
tmuxp is an `abstraction layer ` against tmux' command line arguments.
10
12
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 ` .
14
16
15
17
======================== ======================= =========================
16
18
Object Child Parent
@@ -29,7 +31,9 @@ A server can have multiple sessions. ``Ctrl-a s`` can be used to switch
29
31
between sessions running on the server.
30
32
31
33
Sessions, 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.
33
37
34
38
======================== ======================= =========================
35
39
Object Prefix Example
You can’t perform that action at this time.
0 commit comments