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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
.. tui widgets documentation main file
Tui Widgets
===========
Tui Widgets is high-level widget based toolkit for terminal applications.
Tui Widgets is designed to be flexible and similar to use to Qt graphical widgets.
Its look and feel is similar to graphical applications
or classic full screen terminal applications from the PC world of the 90s.
Features
--------
* works with the Qt event loop and object model
* ready to use user interface elements (text entry, checkboxes, buttons, layout managers, menu etc)
* overlapping window support
* robust input handling
* 24-bit color, soft line breaks, explicit control of trailing whitespace
* does not depend on correctly set $TERM or terminfo database
* tagged paste
* mostly utf-8 based, string width routines also handle utf-16 and utf-32
* offscreen surfaces/layers
* does not use global variables/singletons whenever possible and can handle multiple terminals in one process
* permissively licensed: Boost Software License 1.0 (but Qt licensing is stricter)
Curent Status
-------------
Planned:
* ABI stability is planned (but breaking changes are still happening)
Does not contain:
* support for non utf-8 capable terminals
.. Termpaint is meant as a basic building block to build more specific libraries upon. There are a lot
.. of different higher layer styles, so it's cleaner to have separate libraries for this.
Minimal example
---------------
A "hello world", with fixed widget positions and size:
See :doc:`getting-started` for full source.
.. literalinclude:: examples/getting-started/getting-started-index.cpp
:caption: UI Setup
:start-after: // snippet-setup-start
:end-before: // snippet-setup-end
:dedent: 8
.. literalinclude:: examples/getting-started/getting-started-index.cpp
:caption: main code
:start-after: // snippet-main-start
:end-before: // snippet-main-end
Support
-------
It's known to work on
* xterm
* vte
* rxvt-unicode
* mintty
* iTerm2
* microsoft terminal
* putty
* konsole
* linux
* freebsd
* and more.
.. toctree::
:maxdepth: 3
:caption: Contents:
getting-started
concepts
building-tuiwidgets
ZTerminal
ZWidget
events
ZPainter
ZCommon
ZColor
ZCommandManager
ZShortcut
ZImage
ZLayout
ZPalette
ZSymbol
ZTextMetrics
ZTest
boxlayouts
ZTextLayout
widgets
misc
qtlogging
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
|
