Provides a two-state checkbox with a text label. More...

Inheritance diagram for Gondwana.Widgets.Controls.CheckBoxWidget:

Public Member Functions
	CheckBoxWidget (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle bounds, string text, bool isChecked=false, string? nickname=null)
	Creates a view-level checkbox.
	CheckBoxWidget (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle bounds, string text, bool isChecked=false, string? nickname=null)
	Creates a scene-layer checkbox.
CheckBoxWidget	SetChecked (bool isChecked)
	Sets the checkbox state.
CheckBoxWidget	Toggle ()
	Toggles the checkbox state.
CheckBoxWidget	SetText (string text)
	Changes the checkbox label text.
CheckBoxWidget	SetColors (Color normal, Color hover, Color mark)
	Sets the normal, hover, and checked-mark colors.
CheckBoxWidget	SetTextColor (SKColor color)
	Sets the label text color.
CheckBoxWidget	SetCheckBoxZOrder (int zOrder)
	Sets the base Z-order used by the checkbox visuals.
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 ProcessShown ()

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

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 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 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 OnPointerDown (WidgetPointerEventArgs args)

Called when a pointer press begins on the widget.

virtual void OnPointerMove (WidgetPointerEventArgs args)

Called when pointer movement is routed to the widget.

virtual void OnPointerUp (WidgetPointerEventArgs args)

Called when a pointer press is released for 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	Box `[get]`
	Gets the outer checkbox indicator.
DirectRectangle	Mark `[get]`
	Gets the filled mark displayed while the checkbox is checked.
TextBlock	Label `[get]`
	Gets the text label displayed beside the checkbox.
bool	IsChecked `[get, set]`
	Gets or sets whether the checkbox is checked.
Rectangle	Bounds `[get]`
	Gets the checkbox bounds in its native coordinate space.
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< bool >?	CheckedChanged
	Occurs when IsChecked changes.
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

Provides a two-state checkbox with a text label.

Definition at line 14 of file CheckBoxWidget.cs.

Constructor & Destructor Documentation

◆ CheckBoxWidget() [1/2]

Gondwana.Widgets.Controls.CheckBoxWidget.CheckBoxWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		View	view,
		Rectangle	bounds,
		string	text,
		bool	isChecked = false,
		string?	nickname = null )

Creates a view-level checkbox.

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.
isChecked	Whether the control starts or becomes checked.
nickname	An optional name used to identify the object.

Definition at line 39 of file CheckBoxWidget.cs.

◆ CheckBoxWidget() [2/2]

Gondwana.Widgets.Controls.CheckBoxWidget.CheckBoxWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		SceneLayer	sceneLayer,
		Rectangle	bounds,
		string	text,
		bool	isChecked = false,
		string?	nickname = null )

Creates a scene-layer checkbox.

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.
isChecked	Whether the control starts or becomes checked.
nickname	An optional name used to identify the object.

Definition at line 73 of file CheckBoxWidget.cs.

Member Function Documentation

◆ OnKeyboardInput()

override void Gondwana.Widgets.Controls.CheckBoxWidget.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 250 of file CheckBoxWidget.cs.

◆ OnPointerClick()

override void Gondwana.Widgets.Controls.CheckBoxWidget.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 238 of file CheckBoxWidget.cs.

◆ OnPointerEnter()

override void Gondwana.Widgets.Controls.CheckBoxWidget.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 224 of file CheckBoxWidget.cs.

◆ OnPointerLeave()

override void Gondwana.Widgets.Controls.CheckBoxWidget.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 231 of file CheckBoxWidget.cs.

◆ ProcessShown()

override void Gondwana.Widgets.Controls.CheckBoxWidget.ProcessShown ( )

protectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 217 of file CheckBoxWidget.cs.

◆ SetCheckBoxZOrder()

CheckBoxWidget Gondwana.Widgets.Controls.CheckBoxWidget.SetCheckBoxZOrder ( int zOrder )

Sets the base Z-order used by the checkbox visuals.

Parameters

zOrder The drawing order relative to other content.

Returns: This instance for fluent chaining.

Definition at line 208 of file CheckBoxWidget.cs.

◆ SetChecked()

CheckBoxWidget Gondwana.Widgets.Controls.CheckBoxWidget.SetChecked ( bool isChecked )

Sets the checkbox state.

Parameters

isChecked Whether the control starts or becomes checked.

Returns: This instance for fluent chaining.

Definition at line 140 of file CheckBoxWidget.cs.

◆ SetColors()

CheckBoxWidget Gondwana.Widgets.Controls.CheckBoxWidget.SetColors	(	Color	normal,
		Color	hover,
		Color	mark )

Sets the normal, hover, and checked-mark colors.

Parameters

normal	The color used in the normal state.
hover	The color used while the pointer is over the control.
mark	The color used for the selection mark.

Returns: This instance for fluent chaining.

Definition at line 178 of file CheckBoxWidget.cs.

◆ SetText()

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

Changes the checkbox label text.

Parameters

text	The text to display.

Returns: This instance for fluent chaining.

Definition at line 165 of file CheckBoxWidget.cs.

◆ SetTextColor()

CheckBoxWidget Gondwana.Widgets.Controls.CheckBoxWidget.SetTextColor ( SKColor color )

Sets the label text color.

Parameters

color The color to apply.

Returns: This instance for fluent chaining.

Definition at line 197 of file CheckBoxWidget.cs.

◆ Toggle()

CheckBoxWidget Gondwana.Widgets.Controls.CheckBoxWidget.Toggle ( )

Toggles the checkbox state.

Returns: This widget for fluent chaining.

Definition at line 155 of file CheckBoxWidget.cs.

Property Documentation

◆ Bounds

Rectangle Gondwana.Widgets.Controls.CheckBoxWidget.Bounds

get

Gets the checkbox bounds in its native coordinate space.

Definition at line 125 of file CheckBoxWidget.cs.

◆ Box

DirectRectangle Gondwana.Widgets.Controls.CheckBoxWidget.Box

get

Gets the outer checkbox indicator.

Definition at line 101 of file CheckBoxWidget.cs.

◆ IsChecked

bool Gondwana.Widgets.Controls.CheckBoxWidget.IsChecked

getset

Gets or sets whether the checkbox is checked.

Definition at line 116 of file CheckBoxWidget.cs.

◆ Label

TextBlock Gondwana.Widgets.Controls.CheckBoxWidget.Label

get

Gets the text label displayed beside the checkbox.

Definition at line 111 of file CheckBoxWidget.cs.

◆ Mark

DirectRectangle Gondwana.Widgets.Controls.CheckBoxWidget.Mark

get

Gets the filled mark displayed while the checkbox is checked.

Definition at line 106 of file CheckBoxWidget.cs.

Event Documentation

◆ CheckedChanged

Action<bool>? Gondwana.Widgets.Controls.CheckBoxWidget.CheckedChanged

Occurs when IsChecked changes.

Definition at line 28 of file CheckBoxWidget.cs.

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ CheckBoxWidget() [1/2]

◆ CheckBoxWidget() [2/2]

Member Function Documentation

◆ OnKeyboardInput()

◆ OnPointerClick()

◆ OnPointerEnter()

◆ OnPointerLeave()

◆ ProcessShown()

◆ SetCheckBoxZOrder()

◆ SetChecked()

◆ SetColors()

◆ SetText()

◆ SetTextColor()

◆ Toggle()

Property Documentation

◆ Bounds

◆ Box

◆ IsChecked

◆ Label

◆ Mark

Event Documentation

◆ CheckedChanged