Provides a selectable, vertically scrolling list of text items. More...

Inheritance diagram for Gondwana.Widgets.Controls.ListBoxWidget:

Public Member Functions
	ListBoxWidget (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle bounds, IEnumerable< string >? items=null, string? nickname=null)
	Creates a view-level list box.
	ListBoxWidget (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle bounds, IEnumerable< string >? items=null, string? nickname=null)
	Creates a scene-layer list box.
ListBoxWidget	SetItems (IEnumerable< string > items)
	Replaces all list items and clears selection.
ListBoxWidget	AddItem (string item)
	Adds an item to the end of the list.
ListBoxWidget	RemoveAt (int index)
	Removes an item by index.
ListBoxWidget	ClearItems ()
	Removes all items and clears selection.
ListBoxWidget	SetSelectedIndex (int index)
	Selects the requested item index. Use -1 to clear selection.
ListBoxWidget	SelectNext ()
	Selects the next item when possible.
ListBoxWidget	SelectPrevious ()
	Selects the previous item when possible.
ListBoxWidget	SetListBoxZOrder (int zOrder)
	Sets the base Z-order used by the list-box visuals.
ListBoxWidget	SetSelectionColor (Color color)
	Sets the selected-row highlight color.
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 ProcessHidden ()

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

override void OnPointerClick (WidgetPointerEventArgs args)

Called when a pointer click is dispatched to the widget.

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

Called when pointer movement is routed to 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 OnMouseWheel (WidgetMouseWheelEventArgs args)

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

Parameters

args	The 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 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 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 list background.
DirectRectangle	SelectionHighlight `[get]`
	Gets the rectangle used to highlight the selected row.
DirectRectangle	VerticalScrollBarTrack `[get]`
	Gets the vertical scrollbar track.
DirectRectangle	VerticalScrollBarThumb `[get]`
	Gets the vertical scrollbar thumb.
IReadOnlyList< string >	Items `[get]`
	Gets the current items.
Rectangle	Bounds `[get]`
	Gets the list-box bounds in its native coordinate space.
int	ItemHeight `[get, set]`
	Gets or sets the height of each row in native pixels.
int	VisibleItemCount `[get]`
	Gets the number of complete rows that can currently be displayed.
ScrollBarVisibility	VerticalScrollBarVisibility `[get, set]`
	Gets or sets when the vertical scrollbar is displayed.
bool	IsVerticalScrollBarVisible `[get]`
	Gets whether the vertical scrollbar is currently displayed.
int	MouseWheelScrollItems `[get, set]`
	Gets or sets the number of items scrolled for one wheel notch.
int	VerticalScrollBarMinimumThumbHeight `[get]`
	Gets the minimum height used for a visible scrollbar thumb.
int	TopIndex `[get, set]`
	Gets or sets the index of the first visible item.
int	SelectedIndex `[get, set]`
	Gets or sets the selected item index. Use -1 to clear selection.
string?	SelectedItem `[get]`
	Gets the selected item text, or `null` when no item is selected.
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< int >?	SelectedIndexChanged
	Occurs when SelectedIndex changes.
Action< int >?	SelectionCommitted
	Occurs when the current selection is explicitly committed.
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 selectable, vertically scrolling list of text items.

Definition at line 15 of file ListBoxWidget.cs.

Constructor & Destructor Documentation

◆ ListBoxWidget() [1/2]

Gondwana.Widgets.Controls.ListBoxWidget.ListBoxWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		View	view,
		Rectangle	bounds,
		IEnumerable< string >?	items = null,
		string?	nickname = null )

Creates a view-level list box.

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.
items	The items.
nickname	An optional name used to identify the object.

Definition at line 55 of file ListBoxWidget.cs.

◆ ListBoxWidget() [2/2]

Gondwana.Widgets.Controls.ListBoxWidget.ListBoxWidget	(	RenderSurfaceHostBase	renderSurfaceHost,
		SceneLayer	sceneLayer,
		Rectangle	bounds,
		IEnumerable< string >?	items = null,
		string?	nickname = null )

Creates a scene-layer list box.

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.
items	The items.
nickname	An optional name used to identify the object.

Definition at line 85 of file ListBoxWidget.cs.

Member Function Documentation

◆ AddItem()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.AddItem ( string item )

Adds an item to the end of the list.

Parameters

item The item.

Returns: This instance for fluent chaining.

Definition at line 257 of file ListBoxWidget.cs.

◆ ClearItems()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.ClearItems ( )

Removes all items and clears selection.

Returns: This instance for fluent chaining.

Definition at line 307 of file ListBoxWidget.cs.

◆ OnKeyboardInput()

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

◆ OnMouseWheel()

override void Gondwana.Widgets.Controls.ListBoxWidget.OnMouseWheel ( WidgetMouseWheelEventArgs args )

protectedvirtual

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

Parameters

args	The event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 525 of file ListBoxWidget.cs.

◆ OnPointerClick()

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

◆ OnPointerDown()

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

◆ OnPointerMove()

override void Gondwana.Widgets.Controls.ListBoxWidget.OnPointerMove ( WidgetPointerEventArgs args )

protectedvirtual

Called when pointer movement is routed to the widget.

Parameters

args	The pointer event data.

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 491 of file ListBoxWidget.cs.

◆ OnPointerUp()

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

◆ ProcessHidden()

override void Gondwana.Widgets.Controls.ListBoxWidget.ProcessHidden ( )

protectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 411 of file ListBoxWidget.cs.

◆ ProcessShown()

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

protectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 403 of file ListBoxWidget.cs.

◆ RemoveAt()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.RemoveAt ( int index )

Removes an item by index.

Parameters

index The index.

Returns: This instance for fluent chaining.

Definition at line 270 of file ListBoxWidget.cs.

◆ SelectNext()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.SelectNext ( )

Selects the next item when possible.

Returns: This instance for fluent chaining.

Definition at line 348 of file ListBoxWidget.cs.

◆ SelectPrevious()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.SelectPrevious ( )

Selects the previous item when possible.

Returns: This instance for fluent chaining.

Definition at line 361 of file ListBoxWidget.cs.

◆ SetItems()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.SetItems ( IEnumerable< string > items )

Replaces all list items and clears selection.

Parameters

items The items.

Returns: This instance for fluent chaining.

Definition at line 234 of file ListBoxWidget.cs.

◆ SetListBoxZOrder()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.SetListBoxZOrder ( int zOrder )

Sets the base Z-order used by the list-box visuals.

Parameters

zOrder The drawing order relative to other content.

Returns: This instance for fluent chaining.

Definition at line 375 of file ListBoxWidget.cs.

◆ SetSelectedIndex()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.SetSelectedIndex ( int index )

Selects the requested item index. Use -1 to clear selection.

Parameters

index The index.

Returns: This instance for fluent chaining.

Definition at line 326 of file ListBoxWidget.cs.

◆ SetSelectionColor()

ListBoxWidget Gondwana.Widgets.Controls.ListBoxWidget.SetSelectionColor ( Color color )

Sets the selected-row highlight color.

Parameters

color The color to apply.

Returns: This instance for fluent chaining.

Definition at line 395 of file ListBoxWidget.cs.

Property Documentation

◆ Background

DirectRectangle Gondwana.Widgets.Controls.ListBoxWidget.Background

get

Gets the list background.

Definition at line 110 of file ListBoxWidget.cs.

◆ Bounds

Rectangle Gondwana.Widgets.Controls.ListBoxWidget.Bounds

get

Gets the list-box bounds in its native coordinate space.

Definition at line 131 of file ListBoxWidget.cs.

◆ IsVerticalScrollBarVisible

bool Gondwana.Widgets.Controls.ListBoxWidget.IsVerticalScrollBarVisible

get

Gets whether the vertical scrollbar is currently displayed.

Definition at line 179 of file ListBoxWidget.cs.

◆ ItemHeight

int Gondwana.Widgets.Controls.ListBoxWidget.ItemHeight

getset

Gets or sets the height of each row in native pixels.

Definition at line 138 of file ListBoxWidget.cs.

◆ Items

IReadOnlyList<string> Gondwana.Widgets.Controls.ListBoxWidget.Items

get

Gets the current items.

Definition at line 126 of file ListBoxWidget.cs.

◆ MouseWheelScrollItems

int Gondwana.Widgets.Controls.ListBoxWidget.MouseWheelScrollItems

getset

Gets or sets the number of items scrolled for one wheel notch.

Definition at line 185 of file ListBoxWidget.cs.

◆ SelectedIndex

int Gondwana.Widgets.Controls.ListBoxWidget.SelectedIndex

getset

Gets or sets the selected item index. Use -1 to clear selection.

Definition at line 216 of file ListBoxWidget.cs.

◆ SelectedItem

string? Gondwana.Widgets.Controls.ListBoxWidget.SelectedItem

get

Gets the selected item text, or null when no item is selected.

Definition at line 225 of file ListBoxWidget.cs.

◆ SelectionHighlight

DirectRectangle Gondwana.Widgets.Controls.ListBoxWidget.SelectionHighlight

get

Gets the rectangle used to highlight the selected row.

Definition at line 115 of file ListBoxWidget.cs.

◆ TopIndex

int Gondwana.Widgets.Controls.ListBoxWidget.TopIndex

getset

Gets or sets the index of the first visible item.

Definition at line 199 of file ListBoxWidget.cs.

◆ VerticalScrollBarMinimumThumbHeight

int Gondwana.Widgets.Controls.ListBoxWidget.VerticalScrollBarMinimumThumbHeight

get

Gets the minimum height used for a visible scrollbar thumb.

Definition at line 194 of file ListBoxWidget.cs.

◆ VerticalScrollBarThumb

DirectRectangle Gondwana.Widgets.Controls.ListBoxWidget.VerticalScrollBarThumb

get

Gets the vertical scrollbar thumb.

Definition at line 121 of file ListBoxWidget.cs.

◆ VerticalScrollBarTrack

DirectRectangle Gondwana.Widgets.Controls.ListBoxWidget.VerticalScrollBarTrack

get

Gets the vertical scrollbar track.

Definition at line 118 of file ListBoxWidget.cs.

◆ VerticalScrollBarVisibility

ScrollBarVisibility Gondwana.Widgets.Controls.ListBoxWidget.VerticalScrollBarVisibility

getset

Gets or sets when the vertical scrollbar is displayed.

Definition at line 162 of file ListBoxWidget.cs.

◆ VisibleItemCount

int Gondwana.Widgets.Controls.ListBoxWidget.VisibleItemCount

get

Gets the number of complete rows that can currently be displayed.

Definition at line 159 of file ListBoxWidget.cs.

Event Documentation

◆ SelectedIndexChanged

Action<int>? Gondwana.Widgets.Controls.ListBoxWidget.SelectedIndexChanged

Occurs when SelectedIndex changes.

Definition at line 40 of file ListBoxWidget.cs.

◆ SelectionCommitted

Action<int>? Gondwana.Widgets.Controls.ListBoxWidget.SelectionCommitted

Occurs when the current selection is explicitly committed.

Definition at line 45 of file ListBoxWidget.cs.

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ ListBoxWidget() [1/2]

◆ ListBoxWidget() [2/2]

Member Function Documentation

◆ AddItem()

◆ ClearItems()

◆ OnKeyboardInput()

◆ OnMouseWheel()

◆ OnPointerClick()

◆ OnPointerDown()

◆ OnPointerMove()

◆ OnPointerUp()

◆ ProcessHidden()

◆ ProcessShown()

◆ RemoveAt()

◆ SelectNext()

◆ SelectPrevious()

◆ SetItems()

◆ SetListBoxZOrder()

◆ SetSelectedIndex()

◆ SetSelectionColor()

Property Documentation

◆ Background

◆ Bounds

◆ IsVerticalScrollBarVisible

◆ ItemHeight

◆ Items

◆ MouseWheelScrollItems

◆ SelectedIndex

◆ SelectedItem

◆ SelectionHighlight

◆ TopIndex

◆ VerticalScrollBarMinimumThumbHeight

◆ VerticalScrollBarThumb

◆ VerticalScrollBarTrack

◆ VerticalScrollBarVisibility

◆ VisibleItemCount

Event Documentation

◆ SelectedIndexChanged

◆ SelectionCommitted