A custom toolbar control that extends Unity's Toolbar with USO UI framework functionality. Provides enhanced styling, field validation, orientation control, and integration with the USO UI system. More...

Inheritance diagram for GWG.UsoUIElements.UsoToolbar:

Public Member Functions
	UsoToolbar ()
	Initializes a new instance of the UsoToolbar class with default settings. Creates a toolbar with USO framework integration and horizontal orientation.
	UsoToolbar (string fieldName)
	Initializes a new instance of the UsoToolbar class with the specified field name. Creates a toolbar with custom identification for binding and reference purposes.
	UsoToolbar (string fieldName, out UsoToolbar newField)
	Initializes a new instance of the UsoToolbar class with field name and returns a reference. Creates a toolbar with custom identification and provides an out parameter for immediate access.
UsoLineItem	GetParentLineItem ()
	Retrieves the first ancestor UsoLineItem control in the visual tree hierarchy. This is useful for accessing parent container functionality and maintaining proper UI structure.
void	InitElement (string fieldName=null)
	Initializes the USO UI element with the specified field name and applies necessary styling classes. This method sets up the basic USO framework integration for the control.
void	SetFieldStatus (FieldStatusTypes fieldStatus)
	Updates the field's status type, which affects its visual appearance and validation state. The status change is automatically reflected in the UI through the FieldStatus property.
void	ShowFieldStatus (bool status)
	Controls the visibility and functionality of the field status/validation system. When disabled, removes validation-related styling from the control.
Public Member Functions inherited from GWG.UsoUIElements.IUsoUiElement
void	AddToClassList (string className)
	Adds the specified CSS class name to this element's class list. This method is inherited from Unity's VisualElement and enables dynamic styling modifications.
void	ApplyBinding (string fieldBindingProp, string fieldBindingPath, BindingMode fieldBindingMode)
	Applies data binding configuration to the specified property of this element using Unity's data binding system. Enables automatic synchronization between the UI element and data source properties.
void	ClearBindings ()
	Removes all data binding configurations from this element. This method is inherited from Unity's VisualElement and provides cleanup functionality for data bindings.
void	RemoveFromClassList (string className)
	Removes the specified CSS class name from this element's class list. This method is inherited from Unity's VisualElement and provides dynamic styling capabilities.

Properties
FieldStatusTypes	FieldStatus `[get, private set]`
	Gets the current field status type, which determines the visual state and validation feedback. This property is automatically reflected in the UI through CSS class modifications.
bool	FieldStatusEnabled `[get, private set]`
	Gets or sets whether field status/validation functionality is enabled for this control. When enabled, adds validation CSS class for styling. When disabled, removes validation styling.
ToolbarOrientation	Orientation `[get, set]`
	Gets or sets the orientation of the toolbar, which controls the layout direction of child elements. Automatically adjusts the flex direction style property to match the specified orientation.

Private Attributes
FieldStatusTypes	_fieldStatus
	Private backing field for the FieldStatus property.
bool	_fieldStatusEnabled
	Private backing field for the FieldStatusEnabled property.
ToolbarOrientation	_orientation = ToolbarOrientation.Horizontal

Static Private Attributes
const string	DefaultBindProp = "value"
	Default binding property used when applying data bindings to this field. Currently set to "value" for potential future binding scenarios.
const string	ElementStylesheet = "uso-toolbar"
	CSS class name applied to all UsoToolbar instances for styling purposes.
const string	ElementValidationClass = "uso-field-validation"
	CSS class name applied when field validation/status functionality is enabled.

Detailed Description

A custom toolbar control that extends Unity's Toolbar with USO UI framework functionality. Provides enhanced styling, field validation, orientation control, and integration with the USO UI system.

This control implements the IUsoUiElement interface to provide consistent behavior across the USO UI framework. It supports field status indicators, custom styling through CSS classes, and flexible orientation control. The toolbar can be configured to display horizontally or vertically, with automatic flex direction adjustment. This control is typically used for grouping related UI controls and actions in a structured layout. The control includes commented code for potential future content container customization.

Constructor & Destructor Documentation

◆ UsoToolbar() [1/3]

GWG.UsoUIElements.UsoToolbar.UsoToolbar ( )

Initializes a new instance of the UsoToolbar class with default settings. Creates a toolbar with USO framework integration and horizontal orientation.

◆ UsoToolbar() [2/3]

GWG.UsoUIElements.UsoToolbar.UsoToolbar ( string fieldName )

Initializes a new instance of the UsoToolbar class with the specified field name. Creates a toolbar with custom identification for binding and reference purposes.

Parameters

fieldName The name to assign to this toolbar element.

◆ UsoToolbar() [3/3]

GWG.UsoUIElements.UsoToolbar.UsoToolbar	(	string	fieldName,
		out UsoToolbar	newField )

Initializes a new instance of the UsoToolbar class with field name and returns a reference. Creates a toolbar with custom identification and provides an out parameter for immediate access.

Parameters

fieldName	The name to assign to this toolbar element.
newField	Output parameter that receives a reference to the newly created toolbar.

Member Function Documentation

◆ GetParentLineItem()

UsoLineItem GWG.UsoUIElements.UsoToolbar.GetParentLineItem ( )

Retrieves the first ancestor UsoLineItem control in the visual tree hierarchy. This is useful for accessing parent container functionality and maintaining proper UI structure.

Returns: The parent UsoLineItem if found; otherwise, null.

◆ InitElement()

void GWG.UsoUIElements.UsoToolbar.InitElement ( string fieldName = null )

Initializes the USO UI element with the specified field name and applies necessary styling classes. This method sets up the basic USO framework integration for the control.

Parameters

fieldName Optional name to assign to the element. If null, no name is set.

The method includes commented code for potential future content container customization. Currently sets up basic styling and field status functionality.

Implements GWG.UsoUIElements.IUsoUiElement.

◆ SetFieldStatus()

void GWG.UsoUIElements.UsoToolbar.SetFieldStatus ( FieldStatusTypes fieldStatus )

Updates the field's status type, which affects its visual appearance and validation state. The status change is automatically reflected in the UI through the FieldStatus property.

Parameters

fieldStatus The new field status type to apply.

Implements GWG.UsoUIElements.IUsoUiElement.

◆ ShowFieldStatus()

void GWG.UsoUIElements.UsoToolbar.ShowFieldStatus ( bool status )

Controls the visibility and functionality of the field status/validation system. When disabled, removes validation-related styling from the control.

Parameters

status True to enable field status functionality; false to disable it.

Implements GWG.UsoUIElements.IUsoUiElement.

Member Data Documentation

◆ _fieldStatus

FieldStatusTypes GWG.UsoUIElements.UsoToolbar._fieldStatus

private

Private backing field for the FieldStatus property.

◆ _fieldStatusEnabled

bool GWG.UsoUIElements.UsoToolbar._fieldStatusEnabled

private

Private backing field for the FieldStatusEnabled property.

◆ _orientation

ToolbarOrientation GWG.UsoUIElements.UsoToolbar._orientation = ToolbarOrientation.Horizontal

private

◆ DefaultBindProp

const string GWG.UsoUIElements.UsoToolbar.DefaultBindProp = "value"

staticprivate

Default binding property used when applying data bindings to this field. Currently set to "value" for potential future binding scenarios.

◆ ElementStylesheet

const string GWG.UsoUIElements.UsoToolbar.ElementStylesheet = "uso-toolbar"

staticprivate

CSS class name applied to all UsoToolbar instances for styling purposes.

◆ ElementValidationClass

const string GWG.UsoUIElements.UsoToolbar.ElementValidationClass = "uso-field-validation"

staticprivate

CSS class name applied when field validation/status functionality is enabled.

Property Documentation

◆ FieldStatus

FieldStatusTypes GWG.UsoUIElements.UsoToolbar.FieldStatus

getprivate set

Gets the current field status type, which determines the visual state and validation feedback. This property is automatically reflected in the UI through CSS class modifications.

The current FieldStatusTypes value indicating the field's validation state.

Implements GWG.UsoUIElements.IUsoUiElement.

◆ FieldStatusEnabled

bool GWG.UsoUIElements.UsoToolbar.FieldStatusEnabled

getprivate set

Gets or sets whether field status/validation functionality is enabled for this control. When enabled, adds validation CSS class for styling. When disabled, removes validation styling.

True if field status functionality is enabled; otherwise, false. Default is false.

Implements GWG.UsoUIElements.IUsoUiElement.

◆ Orientation

ToolbarOrientation GWG.UsoUIElements.UsoToolbar.Orientation

getset

Gets or sets the orientation of the toolbar, which controls the layout direction of child elements. Automatically adjusts the flex direction style property to match the specified orientation.

The ToolbarOrientation value indicating horizontal or vertical layout. Default is Horizontal.

When set to Horizontal, the flex direction is set to Row. When set to Vertical, the flex direction is set to Column. This property provides a convenient way to control toolbar layout without manually setting CSS properties.

Public Member Functions

Properties

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UsoToolbar() [1/3]

◆ UsoToolbar() [2/3]

◆ UsoToolbar() [3/3]

Member Function Documentation

◆ GetParentLineItem()

◆ InitElement()

◆ SetFieldStatus()

◆ ShowFieldStatus()

Member Data Documentation

◆ _fieldStatus

◆ _fieldStatusEnabled

◆ _orientation

◆ DefaultBindProp

◆ ElementStylesheet

◆ ElementValidationClass

Property Documentation

◆ FieldStatus

◆ FieldStatusEnabled

◆ Orientation