Represents a basic text button composed from a rectangle and text block. More...

Inheritance diagram for Gondwana.Widgets.Controls.ButtonWidget:

Public Member Functions
	ButtonWidget (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle bounds, string text, string? nickname=null)
	Initializes a view-level button.
	ButtonWidget (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle bounds, string text, string? nickname=null)
	Initializes a scene-layer button.
ButtonWidget	SetText (string text)
	Sets the button text.
ButtonWidget	SetBackgroundColors (Color normal, Color hover, Color pressed)
	Sets the normal, hover, and pressed background colors.
ButtonWidget	SetTextColor (Color color)
	Sets the button text color.
ButtonWidget	SetButtonZOrder (int zOrder)
	Sets the background Z-order and places the label immediately above it.
void	PerformClick ()
	Programmatically activates the button.
Public Member Functions inherited from Gondwana.Widgets.WidgetBase
virtual bool	HitTest (View view, Point screenPositionPx)
	Determines whether the widget can be hit at the specified screen position within the specified view.
virtual bool	HitTest (Point screenPositionPx)
	Determines whether the widget can be hit at the specified screen position.
WidgetBase	Show ()
	Shows the widget and registers it for input routing.
WidgetBase	Hide ()
	Hides the widget and releases any routed input state.
WidgetBase	Activate ()
	Activates the widget and brings it to the front of the input order.
WidgetBase	Cancel ()
	Cancels the widget.
Public Member Functions inherited from Gondwana.Drawing.Direct.DirectComposite
	DirectComposite (RenderSurfaceHostBase renderSurfaceHost, DirectDrawingMode mode, PointF anchor=default, string? nickname=null)
	Initializes a new instance of the DirectComposite class.
Vector2	GetPosition ()
	Gets the current composite anchor.
void	SetPosition (Vector2 position)
	Sets the composite anchor and repositions all children from their stored offsets.
DirectComposite	SetPosition (float x, float y)
	Sets the composite anchor and repositions all children from their stored offsets.
virtual DirectComposite	Add (IDirectCompositeChild child, bool keepCurrentOffset=true, Vector2? explicitLocalOffsetPx=null)
	Adds a composite-compatible direct drawable as a child.
virtual DirectComposite	Remove (IDirectCompositeChild child)
	Removes a child without disposing it.
virtual DirectComposite	Clear ()
	Removes every child without disposing them.
DirectComposite	SetLocalOffset (IDirectCompositeChild child, Vector2 newLocalOffsetPx)
	Changes one child's local offset and reapplies its position.
DirectComposite	SetZOrder (int zOrder)
	Applies one Z-order to every descendant.
DirectComposite	SetOpacity (float opacity)
	Applies one opacity to every descendant.
DirectComposite	SetIsVisible (bool visible)
	Applies one visibility value to every descendant.
DirectComposite	FadeTo (float targetOpacity, float durationSec)
	Fades every descendant to the requested opacity.
DirectComposite	FadeIn (float durationSec)
	Fades every descendant to full opacity.
DirectComposite	FadeOut (float durationSec)
	Fades every descendant to zero opacity.
RectangleF	GetDrawLocationScreen (View view)
	Gets the union of all visible descendants as projected through a view.
void	Draw (BackbufferBase backbuffer, RectangleF destRectScreen)
	Performs no direct rendering because descendants render independently.
virtual void	Update (long tick)
	Advances composite movement.
virtual void	Dispose ()
	Disposes the composite and every child it owns.

Protected Member Functions

override void OnPointerEnter (WidgetPointerEventArgs args)

Called when a pointer enters the widget bounds.

Parameters

args	The pointer event data.

override void OnPointerLeave (WidgetPointerEventArgs args)

Called when a pointer leaves the widget bounds.

Parameters

args	The pointer event data.

override void OnPointerDown (WidgetPointerEventArgs args)

Called when a pointer press begins on the widget.

Parameters

args	The pointer event data.

override void OnPointerUp (WidgetPointerEventArgs args)

Called when a pointer press is released for the widget.

Parameters

args	The pointer event data.

override void OnPointerClick (WidgetPointerEventArgs args)

Called when a pointer click is dispatched to the widget.

Parameters

args	The pointer event data.

override void OnKeyboardInput (WidgetKeyboardEventArgs args)

Called when keyboard input is routed to the widget.

Parameters

args	The keyboard event data.

Protected Member Functions inherited from Gondwana.Widgets.WidgetBase

WidgetBase (RenderSurfaceHostBase renderSurfaceHost, DirectDrawingMode mode, PointF anchor=default, string? nickname=null)

Initializes a new instance of the WidgetBase class.

virtual void ProcessShown ()

Performs processing when the widget is shown before notification callbacks are invoked.

virtual void ProcessHidden ()

Performs processing when the widget is hidden before notification callbacks are invoked.

virtual void ProcessActivated ()

Performs processing when the widget is activated before notification callbacks are invoked.

virtual void ProcessCancelled ()

Performs processing when the widget is cancelled before notification callbacks are invoked.

virtual void ProcessPointerEnter (WidgetPointerEventArgs args)

Performs processing when a pointer enters the widget before notification callbacks are invoked.

virtual void ProcessPointerLeave (WidgetPointerEventArgs args)

Performs processing when a pointer leaves the widget before notification callbacks are invoked.

virtual void ProcessPointerDown (WidgetPointerEventArgs args)

Performs processing when a pointer press begins on the widget before notification callbacks are invoked.

virtual void ProcessPointerMove (WidgetPointerEventArgs args)

Performs processing when pointer movement is routed to the widget before notification callbacks are invoked.

virtual void ProcessPointerUp (WidgetPointerEventArgs args)

Performs processing when a pointer press is released for the widget before notification callbacks are invoked.

virtual void ProcessFocusGained ()

Performs processing when the widget gains focus before notification callbacks are invoked.

virtual void ProcessFocusLost ()

Performs processing when the widget loses focus before notification callbacks are invoked.

virtual void ProcessKeyboardInput (WidgetKeyboardEventArgs args)

Performs processing when keyboard input is routed to the widget before notification callbacks are invoked.

virtual bool ShouldDispatchPointerClick (WidgetPointerEventArgs args)

Determines whether a pointer-click event should be dispatched for the specified pointer event data.

virtual void OnShown ()

Called when the widget is shown.

virtual void OnHidden ()

Called when the widget is hidden.

virtual void OnActivated ()

Called when the widget is activated.

virtual void OnCancelled ()

Called when the widget is cancelled.

virtual void OnPointerMove (WidgetPointerEventArgs args)

Called when pointer movement is routed to the widget.

virtual void OnMouseWheel (WidgetMouseWheelEventArgs args)

Called when mouse-wheel input is routed to the widget.

virtual void OnFocusGained ()

Called when the widget gains focus.

virtual void OnFocusLost ()

Called when the widget loses focus.

Protected Member Functions inherited from Gondwana.Drawing.Direct.DirectComposite

virtual void OnChildAdded (IDirectCompositeChild child)

Called after a child has been successfully added.

virtual void OnChildRemoved (IDirectCompositeChild child)

Called after a child has been removed from the composite.

Properties
DirectRectangle	Background `[get]`
	Gets the rectangle used as the button background and border.
TextBlock	Label `[get]`
	Gets the text block used as the button label.
Properties inherited from Gondwana.Widgets.WidgetBase
bool	IsInputEnabled `[get, set]`
	Gets or sets a value indicating whether the widget can participate in input routing.
bool	IsPointerInputEnabled `[get, set]`
	Gets or sets a value indicating whether the widget can receive pointer input.
bool	IsKeyboardInputEnabled `[get, set]`
	Gets or sets a value indicating whether the widget can receive keyboard input.
bool	CanReceiveFocus `[get, set]`
	Gets or sets a value indicating whether the widget can receive keyboard focus.
bool	IsFocused `[get, set]`
	Gets a value indicating whether the widget currently has keyboard focus.
Properties inherited from Gondwana.Drawing.Direct.DirectComposite
Guid	Id = Guid.NewGuid() `[get]`
	Gets the unique identifier of the composite.
string?	Nickname `[get]`
	Gets the optional diagnostic nickname of the composite.
RenderSurfaceHostBase	RenderSurfaceHost `[get]`
	Gets the render surface host shared by the composite and its children.
DirectDrawingMode	Mode `[get]`
	Gets the coordinate mode shared by the composite and its children.
SceneLayer?	SceneLayer `[get]`
	Gets the scene layer shared by all children in scene-layer mode.
View?	View `[get]`
	Gets the view shared by all children in view mode.
ReadOnlyCollection< IDirectCompositeChild >	Children `[get]`
	Gets the children owned by the composite.
MovementController	Movement `[get]`
	Gets the movement controller used to move the composite anchor.
MovementSpace	PositionSpace `[get]`
	Gets the coordinate space used by the movement controller.
bool	Visible `[get, set]`
	Gets or sets the visibility of all descendants.
int	ZOrder `[get]`
	Gets the composite Z-order.
Rectangle	ScreenBounds `[get]`
	Gets the union of all visible descendants' screen-space bounds.
Rectangle	WorldBounds `[get]`
	Gets the union of all visible descendants' world-space bounds.

Events
Action?	Clicked
	Occurs when the button is activated by pointer or keyboard.
Events inherited from Gondwana.Widgets.WidgetBase
Action?	Shown
	Occurs when the widget is shown.
Action?	Hidden
	Occurs when the widget is hidden.
Action?	Activated
	Occurs when the widget is activated.
Action?	Cancelled
	Occurs when the widget is cancelled.
Action< WidgetPointerEventArgs >?	PointerEnter
	Occurs when a pointer enters the widget bounds.
Action< WidgetPointerEventArgs >?	PointerLeave
	Occurs when a pointer leaves the widget bounds.
Action< WidgetPointerEventArgs >?	PointerDown
	Occurs when a pointer button or touch press begins on the widget.
Action< WidgetPointerEventArgs >?	PointerMove
	Occurs when a pointer moves while routed to the widget.
Action< WidgetPointerEventArgs >?	PointerUp
	Occurs when a pointer button or touch press is released for the widget.
Action< WidgetPointerEventArgs >?	PointerClick
	Occurs when a pointer press and release completes as a click on the widget.
Action< WidgetMouseWheelEventArgs >?	MouseWheel
	Occurs when mouse-wheel input is routed to the widget while the pointer is over it.
Action?	FocusGained
	Occurs when the widget gains keyboard focus.
Action?	FocusLost
	Occurs when the widget loses keyboard focus.
Action< WidgetKeyboardEventArgs >?	KeyboardInput
	Occurs when keyboard input is routed to the widget.
Events inherited from Gondwana.Drawing.Direct.DirectComposite
EventHandler< IDirectDrawable >?	Disposing
	Occurs when the composite is being disposed.
Events inherited from Gondwana.Drawing.Direct.IDirectDrawable
EventHandler< IDirectDrawable >?	Disposing
	Occurs when the object is being disposed.

Detailed Description

Represents a basic text button composed from a rectangle and text block.

Definition at line 14 of file ButtonWidget.cs.

Constructor & Destructor Documentation

◆ ButtonWidget() [1/2]

Gondwana.Widgets.Controls.ButtonWidget.ButtonWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		View	view,
		Rectangle	bounds,
		string	text,
		string?	nickname = null )

Initializes a view-level button.

Parameters

renderSurfaceHost	The render-surface host that owns the drawing.
view	The view used for presentation and coordinate conversion.
bounds	The widget bounds in view-local pixels.
text	The text to display.
nickname	An optional name used to identify the object.

Definition at line 35 of file ButtonWidget.cs.

◆ ButtonWidget() [2/2]

Gondwana.Widgets.Controls.ButtonWidget.ButtonWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		SceneLayer	sceneLayer,
		Rectangle	bounds,
		string	text,
		string?	nickname = null )

Initializes a scene-layer button.

Parameters

renderSurfaceHost	The render-surface host that owns the drawing.
sceneLayer	The scene layer that owns the content.
bounds	The widget bounds in world pixels.
text	The text to display.
nickname	An optional name used to identify the object.

Definition at line 56 of file ButtonWidget.cs.

Member Function Documentation

◆ OnKeyboardInput()

override void Gondwana.Widgets.Controls.ButtonWidget.OnKeyboardInput ( WidgetKeyboardEventArgs args )

protectedvirtual

Called when keyboard input is routed to the widget.

Parameters

args	The keyboard event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 201 of file ButtonWidget.cs.

◆ OnPointerClick()

override void Gondwana.Widgets.Controls.ButtonWidget.OnPointerClick ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer click is dispatched to the widget.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 189 of file ButtonWidget.cs.

◆ OnPointerDown()

override void Gondwana.Widgets.Controls.ButtonWidget.OnPointerDown ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer press begins on the widget.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 173 of file ButtonWidget.cs.

◆ OnPointerEnter()

override void Gondwana.Widgets.Controls.ButtonWidget.OnPointerEnter ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer enters the widget bounds.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 159 of file ButtonWidget.cs.

◆ OnPointerLeave()

override void Gondwana.Widgets.Controls.ButtonWidget.OnPointerLeave ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer leaves the widget bounds.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 166 of file ButtonWidget.cs.

◆ OnPointerUp()

override void Gondwana.Widgets.Controls.ButtonWidget.OnPointerUp ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer press is released for the widget.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 182 of file ButtonWidget.cs.

◆ PerformClick()

void Gondwana.Widgets.Controls.ButtonWidget.PerformClick ( )

Programmatically activates the button.

Definition at line 146 of file ButtonWidget.cs.

◆ SetBackgroundColors()

ButtonWidget Gondwana.Widgets.Controls.ButtonWidget.SetBackgroundColors	(	Color	normal,
		Color	hover,
		Color	pressed )

Sets the normal, hover, and pressed background colors.

Parameters

normal	The color used in the normal state.
hover	The color used while the pointer is over the control.
pressed	The color used while the control is pressed.

Returns: This instance for fluent chaining.

Definition at line 105 of file ButtonWidget.cs.

◆ SetButtonZOrder()

ButtonWidget Gondwana.Widgets.Controls.ButtonWidget.SetButtonZOrder ( int zOrder )

Sets the background Z-order and places the label immediately above it.

Parameters

zOrder The drawing order relative to other content.

Returns: This instance for fluent chaining.

Definition at line 135 of file ButtonWidget.cs.

◆ SetText()

ButtonWidget Gondwana.Widgets.Controls.ButtonWidget.SetText ( string text )

Sets the button text.

Parameters

text	The text to display.

Returns: This instance for fluent chaining.

Definition at line 92 of file ButtonWidget.cs.

◆ SetTextColor()

ButtonWidget Gondwana.Widgets.Controls.ButtonWidget.SetTextColor ( Color color )

Sets the button text color.

Parameters

color The color to apply.

Returns: This instance for fluent chaining.

Definition at line 123 of file ButtonWidget.cs.

Property Documentation

◆ Background

DirectRectangle Gondwana.Widgets.Controls.ButtonWidget.Background

get

Gets the rectangle used as the button background and border.

Definition at line 76 of file ButtonWidget.cs.

◆ Label

TextBlock Gondwana.Widgets.Controls.ButtonWidget.Label

get

Gets the text block used as the button label.

Definition at line 81 of file ButtonWidget.cs.

Event Documentation

◆ Clicked

Action? Gondwana.Widgets.Controls.ButtonWidget.Clicked

Occurs when the button is activated by pointer or keyboard.

Definition at line 23 of file ButtonWidget.cs.

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ ButtonWidget() [1/2]

◆ ButtonWidget() [2/2]

Member Function Documentation

◆ OnKeyboardInput()

◆ OnPointerClick()

◆ OnPointerDown()

◆ OnPointerEnter()

◆ OnPointerLeave()

◆ OnPointerUp()

◆ PerformClick()

◆ SetBackgroundColors()

◆ SetButtonZOrder()

◆ SetText()

◆ SetTextColor()

Property Documentation

◆ Background

◆ Label

Event Documentation

◆ Clicked