summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBoris Faure <billiob@gmail.com>2015-07-22 23:16:23 +0200
committerBoris Faure <billiob@gmail.com>2015-07-22 23:16:23 +0200
commitee6a319f174217f03cff52e722d3af6c0ca170a9 (patch)
treea89ef077e02b0ae595d61b4361378859ed058c63 /src
parent25ec6d06cb74f3a3ce1884fa5ae8593d6b34ea00 (diff)
add some documentation
Diffstat (limited to 'src')
-rw-r--r--src/bin/win.c25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/bin/win.c b/src/bin/win.c
index a17643c..a674922 100644
--- a/src/bin/win.c
+++ b/src/bin/win.c
@@ -15,6 +15,31 @@
15#include "controls.h" 15#include "controls.h"
16#include "term_container.h" 16#include "term_container.h"
17 17
18
19/**
20 * Design:
21 * A terminal widget is Term. It hosts various Evas_Object, like a `termio`
22 * handling the textgrid.
23 * It is hosted in a Term_Container of type Solo.
24 * On Term_Container:
25 * It is a generic structure with a set of function pointers. It is a simple
26 * way to objectify and have genericity between a Window, a Split or Tabs.
27 * Solo, Win, Split, Tabs have a Term_Container as their first field and thus
28 * can be casted to Term_Container to have access to those APIs.
29 *
30 * Solo is the simplest container, hosting just a Term.
31 * Win is a window and has only one container child.
32 * Split is a widget to separate an area of the screen in 2 and thus has 2
33 * children that can be either Solo or Tabs.
34 * Tabs is a Term_Container containing many containers (at the moment, only
35 * Solo ones) and have a system of tabs.
36 *
37 * All the windows are in the `wins` list.
38 */
39
40
41
42
18/* specific log domain to help debug only terminal code parser */ 43/* specific log domain to help debug only terminal code parser */
19int _win_log_dom = -1; 44int _win_log_dom = -1;
20 45