Controls

Every control by family, and the types they take and return. More...

Topics
	Windows and layout
	Windows, horizontal and vertical groups, areas, scroll bars, caching, label and button groups.
	Text and images
	Text, labels, drag labels, selectable text and images.
	Buttons and toggles
	Buttons, command buttons, toggles, switches and checkboxes.
	Fields
	Text, search, autocomplete, numeric, vector and typed fields, dropdowns, lists and dictionaries.
	Sliders
	Sliders with and without a value field.
	Color and gradient fields
	Color and gradient fields with their picker popups.
	Lists and reorderable groups
	List views and drag-to-reorder groups.
	Tables, trees and grids
	Columns, sorting, selection and data sources for tables, tree views and grid views.
	Tabs, docking and toolbars
	Tab bars, dock nodes, dock layouts, documents, toolbars and the toolbar dock.
	Menus, tooltips and dialogs
	Menus, context menus, the menu and title bar, tooltips, message dialogs and toasts.
	Node view
	Nodes, pins and links for the node graph editor.
	Other controls
	Breadcrumb, status bar, command search and the settings panel.

Classes
class	tachyon::LabelBinding
	Links labels to the controls they describe during construction; owned by GUIStateManager. More...
struct	tachyon::ToastAction
	A text button on a toast; the first is drawn in the link color. More...
struct	tachyon::ToastDesc
	What a toast says (ShowToast). Change it later through FindToast. More...
struct	tachyon::BannerAction
	A banner's button or link, right-aligned after its message. More...
struct	tachyon::TypeDimensions< T >
struct	tachyon::TypeDimensions< int2 >
struct	tachyon::TypeDimensions< int3 >
struct	tachyon::TypeDimensions< int4 >
struct	tachyon::TypeDimensions< uint2 >
struct	tachyon::TypeDimensions< uint3 >
struct	tachyon::TypeDimensions< uint4 >
struct	tachyon::TypeDimensions< short2 >
struct	tachyon::TypeDimensions< short3 >
struct	tachyon::TypeDimensions< short4 >
struct	tachyon::TypeDimensions< ushort2 >
struct	tachyon::TypeDimensions< ushort3 >
struct	tachyon::TypeDimensions< ushort4 >
struct	tachyon::TypeDimensions< byte2 >
struct	tachyon::TypeDimensions< byte3 >
struct	tachyon::TypeDimensions< byte4 >
struct	tachyon::TypeDimensions< float2 >
struct	tachyon::TypeDimensions< float3 >
struct	tachyon::TypeDimensions< float4 >
struct	tachyon::TypeDimensions< color4b >
struct	tachyon::TypeDimensions< color4f >
struct	tachyon::MultiSelectState
	Selected item IDs of a multi-select view; user-owned, keep it alive across frames. More...
struct	tachyon::CommandSearchState
	State of a CommandSearch box; user-owned, keep it alive across frames. More...
struct	tachyon::ItemDragDropConfig
	Drag & drop setup for item-based views (tree, list, grid): items drag a payload and accept drops of the same payloadType. More...
struct	tachyon::DoubleClickTracker
	Click-gesture tracker, owned per widget instance so instances (and tests) don't share it. More...
class	tachyon::ButtonGroupSubsystem
	Button/toggle groups: every item takes the group's item style (its :first-child and :last-child rules shape the ends), and a single-item group reverts to "solo", a plain button, in EndGroup. More...
struct	tachyon::ColorPickerState
	Persistent state of the color picker popup. More...
class	tachyon::ColorPickerSubsystem
	The color picker popup's state plus swatch ColorStyles keyed by swatch ID. More...
struct	tachyon::GradientEditorState
	Gradient editor popup state: edits a working copy, written back each frame it's open. More...
class	tachyon::GradientEditorSubsystem
	The gradient editor's state plus swatch styles keyed by swatch ID, with the same lifecycle as ColorPickerSubsystem's. More...
class	tachyon::LabelGroupSubsystem
	Labels and DragLabels in a label group share a width; dragging any label's right edge resizes them all. More...
struct	tachyon::ReorderableDragState
	Persistent drag state; one drag at a time application-wide. More...
struct	tachyon::ReorderableConstructionState
	Construction state of the current reorderable group. More...
struct	tachyon::ReorderableFocusFollow
	After a keyboard move: where the focus was in the moved item, to put it back there next frame, in the item's new slot, unless its ID moved with the item. More...
class	tachyon::ReorderableSubsystem
	Drag and construction state of drag-to-reorder groups, used by the Begin/EndReorderableGroup and Begin/EndReorderableItem widgets. More...
class	tachyon::RenameSubsystem
	In-place rename of a tree / list / grid row (F2, Ctrl+Shift+Click or a slow re-click); the target row emits a text field instead of its label. More...
class	tachyon::SliderFieldTrackSubsystem
	Slider track widths written by the sliders' custom draws and read next frame (keyboard step sizes, drag mapping). More...
struct	tachyon::DockTabDragInfo
	Set when a dock tab drag starts, so any target leaf can emit a phantom tab during construction. More...
struct	tachyon::DockDropZoneAnim
	The drop-zone overlay shown while a dock tab is dragged; it slides between zones. More...
class	tachyon::DockTabDragSubsystem
	Dock tab drag state: the dragged tab and the drop-zone overlay animation. More...
class	tachyon::ToolbarWindowDragSubsystem
	A floating toolbar window dragged by its thumb; one drag at a time. More...
class	tachyon::MenuRectsSubsystem
	Last frame's screen rects of menu triggers and popups, written by AddPostLayout callbacks. More...
class	tachyon::UICacheManager
	Retained-render cache for BeginCached/EndCached scopes. More...

Typedefs
using	tachyon::ToastID = uint32_t
	A toast shown by ShowToast; 0 is none.

Enumerations
enum class	tachyon::Severity : uint8_t { tachyon::Severity::Info , tachyon::Severity::Success , tachyon::Severity::Warning , tachyon::Severity::Error }
	How serious a notification is: its icon and color. More...
enum class	tachyon::BannerActionKind : uint8_t { tachyon::BannerActionKind::Primary , tachyon::BannerActionKind::Secondary , tachyon::BannerActionKind::Link }
	How a banner's action is drawn. More...
enum class	tachyon::TreeDropPosition : uint8_t {   tachyon::TreeDropPosition::None = 0 , tachyon::TreeDropPosition::Before , tachyon::TreeDropPosition::Inside , tachyon::TreeDropPosition::InsideLast ,   tachyon::TreeDropPosition::After }
	Where a tree reorder drop lands relative to the target row. More...
enum class	tachyon::ReorderDirection : uint8_t { tachyon::ReorderDirection::Horizontal , tachyon::ReorderDirection::Vertical }
	Main axis of a reorderable group. More...

Detailed Description

Every control by family, and the types they take and return.

Controls are member functions of tachyon::GUIApplication. Guide: Controls.

Typedef Documentation

ToastID

using tachyon::ToastID = uint32_t

#include <gui_controls/gui_notification_types.h>

A toast shown by ShowToast; 0 is none.

Enumeration Type Documentation

Severity

enum class tachyon::Severity : uint8_t

strong

#include <gui_controls/gui_notification_types.h>

How serious a notification is: its icon and color.

Enumerator
Info
Success
Warning
Error

BannerActionKind

enum class tachyon::BannerActionKind : uint8_t

strong

#include <gui_controls/gui_notification_types.h>

How a banner's action is drawn.

Enumerator
Primary
Secondary
Link

TreeDropPosition

enum class tachyon::TreeDropPosition : uint8_t

strong

#include <gui_controls/gui_widget_state_types.h>

Where a tree reorder drop lands relative to the target row.

Enumerator
None
Before	previous sibling of the target (line at the row top)
Inside	first child of an open target branch (indented line at the row bottom)
InsideLast	last child of the target (rectangle around the row)
After	next sibling of the target (line at the row bottom)

ReorderDirection

enum class tachyon::ReorderDirection : uint8_t

strong

#include <gui_controls/subsystems/gui_reorderable_subsystem.h>

Main axis of a reorderable group.

Enumerator
Horizontal
Vertical