Provides the base implementation for widgets that can be drawn and receive pointer, keyboard, and focus input. More...

Inheritance diagram for Gondwana.Widgets.WidgetBase:

Public Member Functions
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
	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	OnPointerEnter (WidgetPointerEventArgs args)
	Called when a pointer enters the widget bounds.
virtual void	OnPointerLeave (WidgetPointerEventArgs args)
	Called when a pointer leaves the widget bounds.
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	OnPointerClick (WidgetPointerEventArgs args)
	Called when a pointer click is dispatched to the widget.
virtual void	OnFocusGained ()
	Called when the widget gains focus.
virtual void	OnFocusLost ()
	Called when the widget loses focus.
virtual void	OnKeyboardInput (WidgetKeyboardEventArgs args)
	Called when keyboard input is routed to the widget.
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
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?	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 the base implementation for widgets that can be drawn and receive pointer, keyboard, and focus input.

Definition at line 11 of file WidgetBase.cs.

Constructor & Destructor Documentation

◆ WidgetBase()

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

protected

Initializes a new instance of the WidgetBase class.

Parameters

renderSurfaceHost	The render surface host that owns the widget.
mode	The drawing mode used to render the widget.
anchor	The anchor position used by the widget.
nickname	The optional nickname assigned to the widget.

Definition at line 95 of file WidgetBase.cs.

Member Function Documentation

◆ Activate()

WidgetBase Gondwana.Widgets.WidgetBase.Activate ( )

Activates the widget and brings it to the front of the input order.

Returns: The current widget instance.

Definition at line 309 of file WidgetBase.cs.

◆ Cancel()

WidgetBase Gondwana.Widgets.WidgetBase.Cancel ( )

Cancels the widget.

Returns: The current widget instance.

Definition at line 324 of file WidgetBase.cs.

◆ Hide()

WidgetBase Gondwana.Widgets.WidgetBase.Hide ( )

Hides the widget and releases any routed input state.

Returns: The current widget instance.

Definition at line 292 of file WidgetBase.cs.

◆ HitTest() [1/2]

virtual bool Gondwana.Widgets.WidgetBase.HitTest ( Point screenPositionPx )

virtual

Determines whether the widget can be hit at the specified screen position.

Parameters

screenPositionPx The screen position, in pixels, to test.

Returns: true if the widget contains the specified screen position; otherwise, false.

Definition at line 252 of file WidgetBase.cs.

◆ HitTest() [2/2]

virtual bool Gondwana.Widgets.WidgetBase.HitTest	(	View	view,
		Point	screenPositionPx )

virtual

Determines whether the widget can be hit at the specified screen position within the specified view.

Parameters

view	The view to evaluate the hit test against.
screenPositionPx	The screen position, in pixels, to test.

Returns: true if the widget contains the specified screen position; otherwise, false.

Definition at line 203 of file WidgetBase.cs.

◆ OnActivated()

virtual void Gondwana.Widgets.WidgetBase.OnActivated ( )

protectedvirtual

Called when the widget is activated.

Definition at line 553 of file WidgetBase.cs.

◆ OnCancelled()

virtual void Gondwana.Widgets.WidgetBase.OnCancelled ( )

protectedvirtual

Called when the widget is cancelled.

Reimplemented in Gondwana.Widgets.Dialogs.DialogBox.

Definition at line 558 of file WidgetBase.cs.

◆ OnFocusGained()

virtual void Gondwana.Widgets.WidgetBase.OnFocusGained ( )

protectedvirtual

Called when the widget gains focus.

Reimplemented in Gondwana.Widgets.Controls.TextBoxWidget.

Definition at line 605 of file WidgetBase.cs.

◆ OnFocusLost()

virtual void Gondwana.Widgets.WidgetBase.OnFocusLost ( )

protectedvirtual

Called when the widget loses focus.

Reimplemented in Gondwana.Widgets.Controls.TextBoxWidget.

Definition at line 610 of file WidgetBase.cs.

◆ OnHidden()

virtual void Gondwana.Widgets.WidgetBase.OnHidden ( )

protectedvirtual

Called when the widget is hidden.

Definition at line 548 of file WidgetBase.cs.

◆ OnKeyboardInput()

virtual void Gondwana.Widgets.WidgetBase.OnKeyboardInput ( WidgetKeyboardEventArgs args )

protectedvirtual

Called when keyboard input is routed to the widget.

Parameters

args	The keyboard event data.

Reimplemented in Gondwana.Widgets.Controls.ButtonWidget, Gondwana.Widgets.Controls.CheckBoxWidget, Gondwana.Widgets.Controls.HyperlinkWidget, Gondwana.Widgets.Controls.ListBoxWidget, Gondwana.Widgets.Controls.RadioButtonWidget, Gondwana.Widgets.Controls.TabControlWidget, Gondwana.Widgets.Controls.TextBoxWidget, Gondwana.Widgets.Dialogs.ConversationBox, Gondwana.Widgets.Dialogs.DialogBox, Gondwana.Widgets.Menus.MenuBarWidget, Gondwana.Widgets.Menus.MenuHeaderWidget, and Gondwana.Widgets.Menus.MenuItemWidget.

Definition at line 616 of file WidgetBase.cs.

◆ OnMouseWheel()

virtual void Gondwana.Widgets.WidgetBase.OnMouseWheel ( WidgetMouseWheelEventArgs args )

protectedvirtual

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

Parameters

args	The event data.

Reimplemented in Gondwana.Widgets.Controls.LabelWidget, and Gondwana.Widgets.Controls.ListBoxWidget.

Definition at line 594 of file WidgetBase.cs.

◆ OnPointerClick()

virtual void Gondwana.Widgets.WidgetBase.OnPointerClick ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer click is dispatched to the widget.

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.Controls.ButtonWidget, Gondwana.Widgets.Controls.CheckBoxWidget, Gondwana.Widgets.Controls.HyperlinkWidget, Gondwana.Widgets.Controls.ListBoxWidget, Gondwana.Widgets.Controls.RadioButtonWidget, Gondwana.Widgets.Controls.TextBoxWidget, Gondwana.Widgets.Dialogs.ConversationBox, Gondwana.Widgets.Menus.MenuHeaderWidget, Gondwana.Widgets.Menus.MenuItemWidget, and Gondwana.Widgets.Overlays.ToastWidget.

Definition at line 600 of file WidgetBase.cs.

◆ OnPointerDown()

virtual void Gondwana.Widgets.WidgetBase.OnPointerDown ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer press begins on the widget.

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.Controls.ButtonWidget, Gondwana.Widgets.Controls.LabelWidget, Gondwana.Widgets.Controls.ListBoxWidget, Gondwana.Widgets.Menus.MenuHeaderWidget, and Gondwana.Widgets.Menus.MenuItemWidget.

Definition at line 576 of file WidgetBase.cs.

◆ OnPointerEnter()

virtual void Gondwana.Widgets.WidgetBase.OnPointerEnter ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer enters the widget bounds.

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.Controls.ButtonWidget, Gondwana.Widgets.Controls.CheckBoxWidget, Gondwana.Widgets.Controls.HyperlinkWidget, Gondwana.Widgets.Controls.RadioButtonWidget, Gondwana.Widgets.Menus.MenuHeaderWidget, and Gondwana.Widgets.Menus.MenuItemWidget.

Definition at line 564 of file WidgetBase.cs.

◆ OnPointerLeave()

virtual void Gondwana.Widgets.WidgetBase.OnPointerLeave ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer leaves the widget bounds.

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.Controls.ButtonWidget, Gondwana.Widgets.Controls.CheckBoxWidget, Gondwana.Widgets.Controls.HyperlinkWidget, Gondwana.Widgets.Controls.RadioButtonWidget, Gondwana.Widgets.Menus.MenuHeaderWidget, and Gondwana.Widgets.Menus.MenuItemWidget.

Definition at line 570 of file WidgetBase.cs.

◆ OnPointerMove()

virtual void Gondwana.Widgets.WidgetBase.OnPointerMove ( WidgetPointerEventArgs args )

protectedvirtual

Called when pointer movement is routed to the widget.

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.Controls.LabelWidget, and Gondwana.Widgets.Controls.ListBoxWidget.

Definition at line 582 of file WidgetBase.cs.

◆ OnPointerUp()

virtual void Gondwana.Widgets.WidgetBase.OnPointerUp ( WidgetPointerEventArgs args )

protectedvirtual

Called when a pointer press is released for the widget.

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.Controls.ButtonWidget, Gondwana.Widgets.Controls.LabelWidget, Gondwana.Widgets.Controls.ListBoxWidget, Gondwana.Widgets.Menus.MenuHeaderWidget, and Gondwana.Widgets.Menus.MenuItemWidget.

Definition at line 588 of file WidgetBase.cs.

◆ OnShown()

virtual void Gondwana.Widgets.WidgetBase.OnShown ( )

protectedvirtual

Called when the widget is shown.

Definition at line 543 of file WidgetBase.cs.

◆ ProcessActivated()

virtual void Gondwana.Widgets.WidgetBase.ProcessActivated ( )

protectedvirtual

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

Reimplemented in Gondwana.Widgets.ContainerWidget, Gondwana.Widgets.Controls.TabControlWidget, and Gondwana.Widgets.Dialogs.DialogBox.

Definition at line 475 of file WidgetBase.cs.

◆ ProcessCancelled()

virtual void Gondwana.Widgets.WidgetBase.ProcessCancelled ( )

protectedvirtual

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

Reimplemented in Gondwana.Widgets.ContainerWidget, Gondwana.Widgets.DraggableContainerWidget, and Gondwana.Widgets.DraggableWidgetBase.

Definition at line 480 of file WidgetBase.cs.

◆ ProcessFocusGained()

virtual void Gondwana.Widgets.WidgetBase.ProcessFocusGained ( )

protectedvirtual

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

Definition at line 515 of file WidgetBase.cs.

◆ ProcessFocusLost()

virtual void Gondwana.Widgets.WidgetBase.ProcessFocusLost ( )

protectedvirtual

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

Definition at line 520 of file WidgetBase.cs.

◆ ProcessHidden()

virtual void Gondwana.Widgets.WidgetBase.ProcessHidden ( )

protectedvirtual

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

Reimplemented in Gondwana.Widgets.ContainerWidget, Gondwana.Widgets.Controls.ComboBoxWidget, Gondwana.Widgets.Controls.LabelWidget, Gondwana.Widgets.Controls.ListBoxWidget, Gondwana.Widgets.Controls.TabControlWidget, Gondwana.Widgets.DraggableContainerWidget, Gondwana.Widgets.DraggableWidgetBase, Gondwana.Widgets.Hud.ProfilerWidget, Gondwana.Widgets.Menus.MenuBarWidget, Gondwana.Widgets.Menus.MenuDropDownWidget, Gondwana.Widgets.Overlays.PopupWidget, and Gondwana.Widgets.Overlays.ToastWidget.

Definition at line 470 of file WidgetBase.cs.

◆ ProcessKeyboardInput()

virtual void Gondwana.Widgets.WidgetBase.ProcessKeyboardInput ( WidgetKeyboardEventArgs args )

protectedvirtual

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

Parameters

args	The keyboard event data.

Definition at line 526 of file WidgetBase.cs.

◆ ProcessPointerDown()

virtual void Gondwana.Widgets.WidgetBase.ProcessPointerDown ( WidgetPointerEventArgs args )

protectedvirtual

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

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.DraggableContainerWidget, and Gondwana.Widgets.DraggableWidgetBase.

Definition at line 498 of file WidgetBase.cs.

◆ ProcessPointerEnter()

virtual void Gondwana.Widgets.WidgetBase.ProcessPointerEnter ( WidgetPointerEventArgs args )

protectedvirtual

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

Parameters

args	The pointer event data.

Definition at line 486 of file WidgetBase.cs.

◆ ProcessPointerLeave()

virtual void Gondwana.Widgets.WidgetBase.ProcessPointerLeave ( WidgetPointerEventArgs args )

protectedvirtual

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

Parameters

args	The pointer event data.

Definition at line 492 of file WidgetBase.cs.

◆ ProcessPointerMove()

virtual void Gondwana.Widgets.WidgetBase.ProcessPointerMove ( WidgetPointerEventArgs args )

protectedvirtual

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

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.DraggableContainerWidget, and Gondwana.Widgets.DraggableWidgetBase.

Definition at line 504 of file WidgetBase.cs.

◆ ProcessPointerUp()

virtual void Gondwana.Widgets.WidgetBase.ProcessPointerUp ( WidgetPointerEventArgs args )

protectedvirtual

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

Parameters

args	The pointer event data.

Reimplemented in Gondwana.Widgets.DraggableContainerWidget, and Gondwana.Widgets.DraggableWidgetBase.

Definition at line 510 of file WidgetBase.cs.

◆ ProcessShown()

virtual void Gondwana.Widgets.WidgetBase.ProcessShown ( )

protectedvirtual

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

Definition at line 465 of file WidgetBase.cs.

◆ ShouldDispatchPointerClick()

virtual bool Gondwana.Widgets.WidgetBase.ShouldDispatchPointerClick ( WidgetPointerEventArgs args )

protectedvirtual

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

Parameters

args	The pointer event data.

Returns: true if the pointer-click event should be dispatched; otherwise, false.

Reimplemented in Gondwana.Widgets.DraggableContainerWidget, and Gondwana.Widgets.DraggableWidgetBase.

Definition at line 535 of file WidgetBase.cs.

◆ Show()

WidgetBase Gondwana.Widgets.WidgetBase.Show ( )

Shows the widget and registers it for input routing.

Returns: The current widget instance.

Definition at line 275 of file WidgetBase.cs.

Property Documentation

◆ CanReceiveFocus

bool Gondwana.Widgets.WidgetBase.CanReceiveFocus

getset

Gets or sets a value indicating whether the widget can receive keyboard focus.

true if the widget can receive focus; otherwise, false.

Definition at line 172 of file WidgetBase.cs.

◆ IsFocused

bool Gondwana.Widgets.WidgetBase.IsFocused

getset

Gets a value indicating whether the widget currently has keyboard focus.

true if the widget is focused; otherwise, false.

Definition at line 193 of file WidgetBase.cs.

◆ IsInputEnabled

bool Gondwana.Widgets.WidgetBase.IsInputEnabled

getset

Gets or sets a value indicating whether the widget can participate in input routing.

true if input is enabled for the widget; otherwise, false.

Definition at line 109 of file WidgetBase.cs.

◆ IsKeyboardInputEnabled

bool Gondwana.Widgets.WidgetBase.IsKeyboardInputEnabled

getset

Gets or sets a value indicating whether the widget can receive keyboard input.

true if keyboard input is enabled for the widget; otherwise, false.

Definition at line 151 of file WidgetBase.cs.

◆ IsPointerInputEnabled

bool Gondwana.Widgets.WidgetBase.IsPointerInputEnabled

getset

Gets or sets a value indicating whether the widget can receive pointer input.

true if pointer input is enabled for the widget; otherwise, false.

Definition at line 130 of file WidgetBase.cs.

Event Documentation

◆ Activated

Action? Gondwana.Widgets.WidgetBase.Activated

Occurs when the widget is activated.

Definition at line 31 of file WidgetBase.cs.

◆ Cancelled

Action? Gondwana.Widgets.WidgetBase.Cancelled

Occurs when the widget is cancelled.

Definition at line 36 of file WidgetBase.cs.

◆ FocusGained

Action? Gondwana.Widgets.WidgetBase.FocusGained

Occurs when the widget gains keyboard focus.

Definition at line 76 of file WidgetBase.cs.

◆ FocusLost

Action? Gondwana.Widgets.WidgetBase.FocusLost

Occurs when the widget loses keyboard focus.

Definition at line 81 of file WidgetBase.cs.

◆ Hidden

Action? Gondwana.Widgets.WidgetBase.Hidden

Occurs when the widget is hidden.

Definition at line 26 of file WidgetBase.cs.

◆ KeyboardInput

Action<WidgetKeyboardEventArgs>? Gondwana.Widgets.WidgetBase.KeyboardInput

Occurs when keyboard input is routed to the widget.

Definition at line 86 of file WidgetBase.cs.

◆ MouseWheel

Action<WidgetMouseWheelEventArgs>? Gondwana.Widgets.WidgetBase.MouseWheel

Occurs when mouse-wheel input is routed to the widget while the pointer is over it.

Definition at line 71 of file WidgetBase.cs.

◆ PointerClick

Action<WidgetPointerEventArgs>? Gondwana.Widgets.WidgetBase.PointerClick

Occurs when a pointer press and release completes as a click on the widget.

Definition at line 66 of file WidgetBase.cs.

◆ PointerDown

Action<WidgetPointerEventArgs>? Gondwana.Widgets.WidgetBase.PointerDown

Occurs when a pointer button or touch press begins on the widget.

Definition at line 51 of file WidgetBase.cs.

◆ PointerEnter

Action<WidgetPointerEventArgs>? Gondwana.Widgets.WidgetBase.PointerEnter

Occurs when a pointer enters the widget bounds.

Definition at line 41 of file WidgetBase.cs.

◆ PointerLeave

Action<WidgetPointerEventArgs>? Gondwana.Widgets.WidgetBase.PointerLeave

Occurs when a pointer leaves the widget bounds.

Definition at line 46 of file WidgetBase.cs.

◆ PointerMove

Action<WidgetPointerEventArgs>? Gondwana.Widgets.WidgetBase.PointerMove

Occurs when a pointer moves while routed to the widget.

Definition at line 56 of file WidgetBase.cs.

◆ PointerUp

Action<WidgetPointerEventArgs>? Gondwana.Widgets.WidgetBase.PointerUp

Occurs when a pointer button or touch press is released for the widget.

Definition at line 61 of file WidgetBase.cs.

◆ Shown

Action? Gondwana.Widgets.WidgetBase.Shown

Occurs when the widget is shown.

Definition at line 21 of file WidgetBase.cs.

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ WidgetBase()

Member Function Documentation

◆ Activate()

◆ Cancel()

◆ Hide()

◆ HitTest() [1/2]

◆ HitTest() [2/2]

◆ OnActivated()

◆ OnCancelled()

◆ OnFocusGained()

◆ OnFocusLost()

◆ OnHidden()

◆ OnKeyboardInput()

◆ OnMouseWheel()

◆ OnPointerClick()

◆ OnPointerDown()

◆ OnPointerEnter()

◆ OnPointerLeave()

◆ OnPointerMove()

◆ OnPointerUp()

◆ OnShown()

◆ ProcessActivated()

◆ ProcessCancelled()

◆ ProcessFocusGained()

◆ ProcessFocusLost()

◆ ProcessHidden()

◆ ProcessKeyboardInput()

◆ ProcessPointerDown()

◆ ProcessPointerEnter()

◆ ProcessPointerLeave()

◆ ProcessPointerMove()

◆ ProcessPointerUp()

◆ ProcessShown()

◆ ShouldDispatchPointerClick()

◆ Show()

Property Documentation

◆ CanReceiveFocus

◆ IsFocused

◆ IsInputEnabled

◆ IsKeyboardInputEnabled

◆ IsPointerInputEnabled

Event Documentation

◆ Activated

◆ Cancelled

◆ FocusGained

◆ FocusLost

◆ Hidden

◆ KeyboardInput

◆ MouseWheel

◆ PointerClick

◆ PointerDown

◆ PointerEnter

◆ PointerLeave

◆ PointerMove

◆ PointerUp

◆ Shown