Provides a compact selection control that expands into a ListBoxWidget. More...

Inheritance diagram for Gondwana.Widgets.Controls.ComboBoxWidget:

Public Member Functions

ComboBoxWidget (RenderSurfaceHostBase renderSurfaceHost, View view, Rectangle bounds, IEnumerable< string >? items=null, int dropDownHeight=DefaultDropDownHeight, string? nickname=null)

Creates a view-level combo box.

ComboBoxWidget (RenderSurfaceHostBase renderSurfaceHost, SceneLayer sceneLayer, Rectangle bounds, IEnumerable< string >? items=null, int dropDownHeight=DefaultDropDownHeight, string? nickname=null)

Creates a scene-layer combo box.

ComboBoxWidget SetItems (IEnumerable< string > items)

Replaces all available items and clears the current selection.

ComboBoxWidget AddItem (string item)

Adds an item to the end of the combo box.

ComboBoxWidget OpenDropDown ()

Opens the drop-down list when items are available.

ComboBoxWidget CloseDropDown ()

Closes the drop-down list.

ComboBoxWidget ToggleDropDown ()

Toggles the drop-down list.

ComboBoxWidget SetComboBoxZOrder (int zOrder)

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

ComboBoxWidget SetHeaderTextColor (Color color)

Sets the collapsed header text and chevron color.

override void Dispose ()

Disposes the composite and every child it owns.

Public Member Functions inherited from Gondwana.Widgets.ContainerWidget

override DirectComposite Add (IDirectCompositeChild child, bool keepCurrentOffset=true, Vector2? explicitLocalOffsetPx=null)

Adds a composite-compatible direct drawable as a child.

Parameters

child	The child to add.
keepCurrentOffset	`true` to preserve the child's current offset from the composite anchor.
explicitLocalOffsetPx	The offset to use when keepCurrentOffset is `false`.

Returns: The current composite.

Exceptions

ArgumentException	Thrown when the child uses another render surface, mode, view, or scene layer.
InvalidOperationException	Thrown when the child already has another parent or would create a cycle.

override DirectComposite Remove (IDirectCompositeChild child)

Removes a child without disposing it.

Parameters

child The child to detach.

Returns: The current composite.

override DirectComposite Clear ()

Removes every child without disposing them.

Returns: The current composite.

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.

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.

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.

Protected Member Functions inherited from Gondwana.Widgets.ContainerWidget

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

Initializes a new instance of the ContainerWidget class.

TWidget Add< TWidget > (TWidget widget, Vector2 localOffsetPx)

Adds a child widget at a local offset from this container's anchor.

bool RemoveChild (WidgetBase widget, bool dispose=false)

Removes a child widget from the container.

override void OnChildAdded (IDirectCompositeChild child)

Called after a child has been successfully added.

Parameters

child The child that was added.

Overrides should perform only non-throwing bookkeeping. Derived types that need additional validation should override Add, perform that validation before calling the base implementation, and then allow this callback to perform the resulting bookkeeping.

override void OnChildRemoved (IDirectCompositeChild child)

Called after a child has been removed from the composite.

Parameters

child The child that was removed.

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 ProcessActivated ()

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

override void ProcessCancelled ()

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

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 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.

Properties
ButtonWidget	Header `[get]`
	Gets the collapsed button portion of the combo box.
ListBoxWidget	DropDown `[get]`
	Gets the list displayed while the combo box is expanded.
IReadOnlyList< string >	Items `[get]`
	Gets the available items.
bool	IsDropDownOpen `[get]`
	Gets whether the drop-down list is currently open.
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`.
string	Placeholder `[get, set]`
	Gets or sets the text displayed while no item is selected.
Properties inherited from Gondwana.Widgets.ContainerWidget
IReadOnlyList< WidgetBase >	ChildWidgets `[get]`
	Gets a snapshot of the child widgets directly owned by this container.
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.
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 compact selection control that expands into a ListBoxWidget.

Definition at line 15 of file ComboBoxWidget.cs.

Constructor & Destructor Documentation

◆ ComboBoxWidget() [1/2]

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

Creates a view-level combo 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.
dropDownHeight	The drop down height.
nickname	An optional name used to identify the object.

Definition at line 38 of file ComboBoxWidget.cs.

◆ ComboBoxWidget() [2/2]

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

Creates a scene-layer combo 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.
dropDownHeight	The drop down height.
nickname	An optional name used to identify the object.

Definition at line 73 of file ComboBoxWidget.cs.

Member Function Documentation

◆ AddItem()

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

Adds an item to the end of the combo box.

Parameters

item The item.

Returns: This instance for fluent chaining.

Definition at line 163 of file ComboBoxWidget.cs.

◆ CloseDropDown()

ComboBoxWidget Gondwana.Widgets.Controls.ComboBoxWidget.CloseDropDown ( )

Closes the drop-down list.

Returns: This instance for fluent chaining.

Definition at line 189 of file ComboBoxWidget.cs.

◆ Dispose()

override void Gondwana.Widgets.Controls.ComboBoxWidget.Dispose ( )

virtual

Disposes the composite and every child it owns.

Reimplemented from Gondwana.Drawing.Direct.DirectComposite.

Definition at line 230 of file ComboBoxWidget.cs.

◆ OpenDropDown()

ComboBoxWidget Gondwana.Widgets.Controls.ComboBoxWidget.OpenDropDown ( )

Opens the drop-down list when items are available.

Returns: This instance for fluent chaining.

Definition at line 173 of file ComboBoxWidget.cs.

◆ ProcessHidden()

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

protectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 253 of file ComboBoxWidget.cs.

◆ ProcessShown()

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

protectedvirtual

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

Reimplemented from Gondwana.Widgets.WidgetBase.

Definition at line 244 of file ComboBoxWidget.cs.

◆ SetComboBoxZOrder()

ComboBoxWidget Gondwana.Widgets.Controls.ComboBoxWidget.SetComboBoxZOrder ( int zOrder )

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

Parameters

zOrder The drawing order relative to other content.

Returns: This instance for fluent chaining.

Definition at line 209 of file ComboBoxWidget.cs.

◆ SetHeaderTextColor()

ComboBoxWidget Gondwana.Widgets.Controls.ComboBoxWidget.SetHeaderTextColor ( Color color )

Sets the collapsed header text and chevron color.

Parameters

color The color to apply.

Returns: This instance for fluent chaining.

Definition at line 222 of file ComboBoxWidget.cs.

◆ SetItems()

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

Replaces all available items and clears the current selection.

Parameters

items The items.

Returns: This instance for fluent chaining.

Definition at line 151 of file ComboBoxWidget.cs.

◆ ToggleDropDown()

ComboBoxWidget Gondwana.Widgets.Controls.ComboBoxWidget.ToggleDropDown ( )

Toggles the drop-down list.

Returns: This widget for fluent chaining.

Definition at line 199 of file ComboBoxWidget.cs.

Property Documentation

◆ DropDown

ListBoxWidget Gondwana.Widgets.Controls.ComboBoxWidget.DropDown

get

Gets the list displayed while the combo box is expanded.

Definition at line 107 of file ComboBoxWidget.cs.

◆ Header

ButtonWidget Gondwana.Widgets.Controls.ComboBoxWidget.Header

get

Gets the collapsed button portion of the combo box.

Definition at line 102 of file ComboBoxWidget.cs.

◆ IsDropDownOpen

bool Gondwana.Widgets.Controls.ComboBoxWidget.IsDropDownOpen

get

Gets whether the drop-down list is currently open.

Definition at line 117 of file ComboBoxWidget.cs.

◆ Items

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

get

Gets the available items.

Definition at line 112 of file ComboBoxWidget.cs.

◆ Placeholder

string Gondwana.Widgets.Controls.ComboBoxWidget.Placeholder

getset

Gets or sets the text displayed while no item is selected.

Definition at line 136 of file ComboBoxWidget.cs.

◆ SelectedIndex

int Gondwana.Widgets.Controls.ComboBoxWidget.SelectedIndex

getset

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

Definition at line 122 of file ComboBoxWidget.cs.

◆ SelectedItem

string? Gondwana.Widgets.Controls.ComboBoxWidget.SelectedItem

get

Gets the selected item text, or null.

Definition at line 131 of file ComboBoxWidget.cs.

Event Documentation

◆ SelectedIndexChanged

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

Occurs when SelectedIndex changes.

Definition at line 27 of file ComboBoxWidget.cs.

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ ComboBoxWidget() [1/2]

◆ ComboBoxWidget() [2/2]

Member Function Documentation

◆ AddItem()

◆ CloseDropDown()

◆ Dispose()

◆ OpenDropDown()

◆ ProcessHidden()

◆ ProcessShown()

◆ SetComboBoxZOrder()

◆ SetHeaderTextColor()

◆ SetItems()

◆ ToggleDropDown()

Property Documentation

◆ DropDown

◆ Header

◆ IsDropDownOpen

◆ Items

◆ Placeholder

◆ SelectedIndex

◆ SelectedItem

Event Documentation

◆ SelectedIndexChanged