Inheritance diagram for Button:

Classes
struct	VisualState

Public Member Functions
void	UpdateThemeProperties ()
	Retrieves layout properties from the visual style. Called by the UI system on every frame before layout updates occur. If layout properties change during this method call, the widget will automatically invalidate its own layout.

void	OnMouseEnter (MouseMoveEvent e)

void	OnMouseLeave (MouseMoveEvent e)

void	OnMouseDown (MouseButtonEvent e)

void	OnMouseUp (MouseButtonEvent e)

void	OnFocusGained (FocusEvent e)

void	OnFocusLost (FocusEvent e)

struct	LayoutProperties ()

Public Member Functions inherited from Pressable
virtual void	OnMouseClick (MouseButtonEvent e)

void	OnMouseDown (MouseButtonEvent e)

void	OnMouseUp (MouseButtonEvent e)

Public Member Functions inherited from Widget
T?	FindParent< T > ()

IEnumerable< Widget >	EnumerateChildren ()

bool	ContainsChild (Widget? widget)

bool	BelongsToParent (Widget widget)

void	InvalidateClipping (bool recursive=false)

void	InvalidateGeometry (bool invalidateChildren=false)

IVisualStyle?	GetVisualStyleOverride ()
	Walks up the widget tree from this widget to the top-level, returning the first visual style override that isn't null. If no widgets in the path override the global visual style, then null will be returned.

bool	IsInsideClipRegion (Point point)

T	GetCustomProperty< T > ()

void	SetCustomProperty< T > (T newValue)

T	GetCustomProperties< T > ()

IFontFamily	GetFont (PresetFontFamily family)

void	GiveFocus ()

readonly struct	BackgroundStyleProperties (Texture2D? fillImage, Color fillColor, int strokeThickness, Color strokeColor, Rounding rounding)

virtual void	Inspect (IInspector inspector)

void	InvalidateOwnLayout ()

void	Invalidate (InvalidationMode invalidationMode)

void	InvalidateLayout ()

void	UpdateLayout (IGuiContext context, LayoutRect availableSpace)

Point	GetCachedContentSize (Point availableSize)

Protected Member Functions
override void	BeforeRender ()

override void	RebuildGeometry (GeometryHelper geometry)

Protected Member Functions inherited from Pressable
virtual void	OnClick ()

Protected Member Functions inherited from Widget
virtual void	RebuildClippingZone (GeometryHelper geometry)

virtual bool	ShouldRenderChild (Widget childWidget)

virtual void	OnAddedToParent ()

virtual void	OnRemovedFromParent ()

virtual void	OnParentChanged ()

bool	GetTextColor (ref Color color, Color? fallbackColor=null)

void	GetThemeProperties< TThemeProperties > (ref TThemeProperties properties, InvalidationMode invalidationMode=InvalidationMode.LayoutAndGeometry)

virtual void	ArrangeChildren (IGuiContext context, LayoutRect availableSpace)

virtual Point	GetContentSize (Point availableSize)

bool	SendSignal< TSignal > (TSignal signal, SignalDirection direction=SignalDirection.Up)
	Send a signal of type TSignal from this widget.

Properties
bool	IsHovered `[get]`

bool	IsPressed `[get]`

ref readonly VisualState	VisualProperties `[get]`
	Gets a read-only reference to the visual properties associated with the widget.

string	Text `[get, set]`

Properties inherited from Widget
int	ChildCount `[get]`

string?	Name `[get, set]`

ulong	ScreenReaderId `[get]`

ScreenReaderNode	ScreenReaderNode `[get]`

bool	IsLayoutValid `[get]`

ulong	UniqueId `[get]`

Matrix4x4	ComputedTransformMatrix `[get]`

AccessibilityRole	Role `[get, set]`
	Gets or sets a AccessibilityRole value representing the role of this Widget shown to accessibility software. Screen readers use this value to figure out what kind of UI element the widget is.

Widget?	LabelledBy `[get, set]`

string	RoleDescription `[get, set]`

string	AccessibleLabel `[get, set]`
	Gets or sets the accessible label for this widget. This string is read aloud by screen readers.

bool	ClipSelf `[get, set]`

Quaternion	Rotation `[get, set]`

Vector3	Scale `[get, set]`

Point	PositionOffset `[get, set]`

Point	ComputedPositionOffset `[get]`

BackgroundStyleProperties	BackgroundStyle `[get, set]`

IWidgetEffect?	RenderEffect `[get, set]`

bool	IsFocused `[get]`

bool	IsChildFocused `[get]`

LayoutRect?	ClippedContentArea `[get]`

ClippingMode	ClippingMode `[get, set]`

bool	Enabled `[get, set]`

float	RenderOpacity `[get, set]`

bool	HierarchyEnabled `[get]`

float	ComputedOpacity `[get]`

IVisualStyle?	VisualStyleOverride `[get, set]`

Widget?	Parent `[get]`

Widget?	Root `[get]`

virtual ? GuiManager	GuiManager `[get]`

IOrderedCollection< Widget >	InternalChildren `[get]`

Widget?	ContextMenuWidget `[get, set]`
	Gets or sets a widget to be shown when the user right-clicks this widget or one of its children.

bool	IsVisible `[get]`

Visibility	Visibility `[get, set]`

LayoutRect	PaintArea `[get]`

Padding	Margin `[get, set]`

Padding	Padding `[get, set]`

int	MinimumWidth `[get, set]`

int	MinimumHeight `[get, set]`

int	MaximumWidth `[get, set]`

int	MaximumHeight `[get, set]`

Point	MinimumSize `[get, set]`

Point	MaximumSize `[get, set]`

HorizontalAlignment	HorizontalAlignment `[get, set]`

VerticalAlignment	VerticalAlignment `[get, set]`

LayoutRect	LayoutArea `[get]`

Widget	LayoutRoot `[get, protected set]`

PopoverLocationPreference	PopoverLocation `[get, set]`

PopoverContent?	PopoverContent `[get, set]`

Additional Inherited Members
Events inherited from Pressable
Action?	Clicked

Events inherited from Widget
static ? Action< Widget, LayoutRect >	WidgetRepainting = null

Member Function Documentation

◆ BeforeRender()

override void BeforeRender ( )

inlineprotectedvirtual

Reimplemented from Widget.

◆ OnFocusGained()

void OnFocusGained ( FocusEvent e )

inline

Implements IGainFocusHandler.

◆ OnFocusLost()

void OnFocusLost ( FocusEvent e )

inline

Implements ILoseFocusHandler.

◆ OnMouseDown()

void OnMouseDown ( MouseButtonEvent e )

inline

Implements IMouseDownHandler.

◆ OnMouseEnter()

void OnMouseEnter ( MouseMoveEvent e )

inline

Implements IMouseEnterHandler.

◆ OnMouseLeave()

void OnMouseLeave ( MouseMoveEvent e )

inline

Implements IMouseLeaveHandler.

◆ OnMouseUp()

void OnMouseUp ( MouseButtonEvent e )

inline

Implements IMouseUpHandler.

◆ RebuildGeometry()

override void RebuildGeometry ( GeometryHelper geometry )

inlineprotectedvirtual

Reimplemented from Widget.

◆ UpdateThemeProperties()

void UpdateThemeProperties ( )

inline

Retrieves layout properties from the visual style. Called by the UI system on every frame before layout updates occur. If layout properties change during this method call, the widget will automatically invalidate its own layout.

Implements IUpdateThemeProperties.

Property Documentation

◆ VisualProperties

ref readonly VisualState VisualProperties

get

Gets a read-only reference to the visual properties associated with the widget.

Implements IVisual< TVisualProperties >.

The documentation for this class was generated from the following file:

/home/ritchie/Projects/toolbox/src/Ritchie.Toolbox/Widgets/Button.cs

Classes

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Member Function Documentation

◆ BeforeRender()

◆ OnFocusGained()

◆ OnFocusLost()

◆ OnMouseDown()

◆ OnMouseEnter()

◆ OnMouseLeave()

◆ OnMouseUp()

◆ RebuildGeometry()

◆ UpdateThemeProperties()

Property Documentation

◆ VisualProperties