xentara::workbench::ui Namespace Reference

UI classes. More...

Classes
struct	Color
	A color. More...
class	Form
	An interface used to add entry fields to a UI form. More...
class	Group
	A group of entry fields. More...

Typedefs
using	String = std::wstring
	The string type used by the native GUI components.
using	StringView = std::wstring_view
	The string view type used by the native GUI components.
using	Char = wchar_t
	The char type used by the native GUI components.

Enumerations
enum class	Alignment {   Text , Number , Leading , Center ,   Trailing , Left , Right }
	Enum class for text field alignment. More...
enum class	SelectionMode { None , Single , Multiple , Extended }
	The different selection modes for the list box. More...
enum class	FontFamily { Regular , Monospace }
	Fonts families. More...

Detailed Description

UI classes.

This namespace contains the classes necessary to interact with the UI used to edit the skill elements.

Typedef Documentation

Char

using xentara::workbench::ui::Char = typedef wchar_t

The char type used by the native GUI components.

Include file

#include <xentara/workbench/ui/Types.hpp>

String

using xentara::workbench::ui::String = typedef std::wstring

The string type used by the native GUI components.

Include file

#include <xentara/workbench/ui/Types.hpp>

StringView

using xentara::workbench::ui::StringView = typedef std::wstring_view

The string view type used by the native GUI components.

Include file

#include <xentara/workbench/ui/Types.hpp>

Enumeration Type Documentation

Alignment

enum class xentara::workbench::ui::Alignment

strong

Enum class for text field alignment.

Include file

#include <xentara/workbench/ui/Types.hpp>

Enumerator
Text	Align for text entry.
Number	Align for numeric entry.
Leading	Align the leading edge of the text.
Center	Align at the center.
Trailing	Align the trailing edge of the text.
Left	Align to the left irrespective of text direction.
Right	Align to the right irrespective of text direction.

FontFamily

enum class xentara::workbench::ui::FontFamily

strong

Fonts families.

Include file

#include <xentara/workbench/ui/Types.hpp>

Enumerator
Regular	The normal system font family.
Monospace	A monospace font family.

SelectionMode

enum class xentara::workbench::ui::SelectionMode

strong

The different selection modes for the list box.

Include file

#include <xentara/workbench/ui/Types.hpp>

Enumerator
None	No selection possible.
Single	Only a single entry is selectable.
Multiple	Multiple entries can be selected via checkbox.
Extended	Using ctrl and shift, individual or continuous items in the list can be selected, no checkbox.