Tg Namespace Reference

All Terminal GUI classes (both core and widgets) are defined within the Tg namespace. More...

Namespaces
	Command
	Various ANSI code commands.
	Key
	Characters and escape sequences which can be found in keyboard buffer (see Terminal::getChar()).

Classes
class	BorderStyle
	Defines colors, characters with which Widget draws it's borders. More...
class	Button
struct	CheckableString
class	CheckableStringListModel
class	CheckBox
class	ChildFillsParentLayout
	This Layout works only on a single child of parent() Widget and stretches it to fill the parent(). More...
class	Color
	Represents colors in a terminal. More...
class	ColumnLayout
	Arranges all children of parent() Widget in a single column. More...
class	ExclusiveGroup
class	GridLayout
	Arranges children of parent() Widget in a grid. More...
class	Label
class	Layout
	Helper class for Widget, manages positions and sizes of Widget's children. More...
class	LineEdit
class	ListView
class	RadioButton
class	RawTerminalLocker
	Simple RAII class - sets proper echo mode in terminal for the duration of application run. More...
class	ReversibleAnimation
	Small convenience class: a property animation which goes backwards after it reaches it's end, thus forming a "to and from" looped animation. More...
class	RowLayout
	Arranges all children of parent() Widget in a single row. More...
class	Screen
	Screen is the "canvas" on which widgets (subclasses of Widget) are drawn. More...
class	ScrollArea
class	ScrollBar
class	Style
	Defines how Widget (and all it's subclasses) draw their contents. More...
class	TableBorderStyle
	Alternative to BorderStyle: it draws the borders using 2 parallel lines instead of one. More...
class	Terminal
	Cross-platform representation of terminal window. More...
class	Widget
	Base class for all widgets in a Terminal Gui application. More...

Typedefs
using	CheckableStringList = QList< CheckableString >
using	BorderStylePointer = QSharedPointer< Tg::BorderStyle >
using	WidgetPointer = QPointer< Widget >
	Convenient alias of QPointer<Widget>.
using	WidgetList = QList< WidgetPointer >
	Convenient alias for QList<WidgetPointer>.
using	StylePointer = QSharedPointer< Style >
	Convenient alias of QSharedPointer<Style>.
using	ExclusiveGroupPointer = QSharedPointer< ExclusiveGroup >

Enumerations
enum	Overshoot { Overshoot::None = 0x00, Overshoot::Horizontal = 0x01, Overshoot::Vertical = 0x02 }
	Describes situation when items in layout cannot fit into parent widget or widget contents do not fit it's size. More...
enum	RedrawType { RedrawType::Partial, FulLWidget = Partial, RedrawType::PreviousPosition, RedrawType::Full }
	Specifies how much of the Tg::Screen needs to be redrawn. More...
enum	WidgetType { TopLevel, All }

Detailed Description

All Terminal GUI classes (both core and widgets) are defined within the Tg namespace.

Additionally, all source and header files are prefixed with "tg", followed by class name written all in lower case.

Enumeration Type Documentation

Overshoot

enum Tg::Overshoot

strong

Describes situation when items in layout cannot fit into parent widget or widget contents do not fit it's size.

Enumerator
None	There is no overshoot - widgets in layout fit nicely into the parent widget
Horizontal	Children widgets do not fit in the horizontal direction.
Vertical	Children widgets do not fit in the vertical direction.

RedrawType

enum Tg::RedrawType

strong

Specifies how much of the Tg::Screen needs to be redrawn.

Enumerator
Partial	Only redraw a part of the screen.
PreviousPosition	Area where widget used to be should be redrawn.
Full	Redraw everything.