Gondwana.Widgets.Menus.MenuDropDownWidget Class Reference

Represents a popup command list owned by a header or submenu item. More...

Inheritance diagram for Gondwana.Widgets.Menus.MenuDropDownWidget:

Public Member Functions
MenuDropDownWidget	AddItem (string text, Action? action=null, string? shortcutText=null, bool enabled=true, string? key=null, KeyGesture? shortcut=null, char? mnemonic=null, SKImage? icon=null)
	Adds a command, preserving fluent construction. Gesture text overrides display-only shortcutText.
MenuDropDownWidget	AddCheckItem (string text, Action< bool >? action=null, bool isChecked=false, bool enabled=true, string? key=null, KeyGesture? shortcut=null, char? mnemonic=null, SKImage? icon=null)
	Adds a check item. Invocation toggles state before passing the resulting value to the callback.
MenuDropDownWidget	AddRadioItem (string text, Action? action, string group, bool isChecked=false, bool enabled=true, string? key=null, KeyGesture? shortcut=null, char? mnemonic=null, SKImage? icon=null)
	Adds a radio command. Group names are scoped to this dropdown; the last checked item wins.
MenuDropDownWidget	AddSubMenu (string text, Action< MenuDropDownWidget > configure, bool enabled=true, string? key=null, char? mnemonic=null, SKImage? icon=null)
	Adds an owned submenu. Submenus may themselves contain submenus to any depth.
MenuDropDownWidget	AddSeparator ()
	Adds a visual separator.
MenuDropDownWidget	SetWidth (int width)
	Sets a fixed minimum width for this dropdown.
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	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
DirectRectangle	Panel [get]
	Gets the popup panel drawing.
IReadOnlyList< MenuItemWidget >	Items [get]
	Gets the actionable entries in insertion order.
int	Width [get]
	Gets the current popup width.
int	Height [get]
	Gets the current popup height.
bool	IsOpen [get]
	Gets whether this dropdown accepts input. False while its close animation finishes.
int	SelectedIndex [get]
	Gets the selected actionable-item index, or -1.
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.

Additional Inherited Members
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 popup command list owned by a header or submenu item.

Definition at line 13 of file MenuDropDownWidget.cs.

Member Function Documentation

AddCheckItem()

MenuDropDownWidget Gondwana.Widgets.Menus.MenuDropDownWidget.AddCheckItem	(	string	text,
		Action< bool >?	action = null,
		bool	isChecked = false,
		bool	enabled = true,
		string?	key = null,
		KeyGesture?	shortcut = null,
		char?	mnemonic = null,
		SKImage?	icon = null )

Adds a check item. Invocation toggles state before passing the resulting value to the callback.

Parameters

text	The text to display.
action	The action.
isChecked	Whether the control starts or becomes checked.
enabled	Whether the feature is enabled.
key	The lookup key for the resource.
shortcut	The shortcut text displayed alongside the item.
mnemonic	The keyboard mnemonic used to activate the item.
icon	The icon.

Returns

This instance for fluent chaining.

Definition at line 113 of file MenuDropDownWidget.cs.

AddItem()

MenuDropDownWidget Gondwana.Widgets.Menus.MenuDropDownWidget.AddItem	(	string	text,
		Action?	action = null,
		string?	shortcutText = null,
		bool	enabled = true,
		string?	key = null,
		KeyGesture?	shortcut = null,
		char?	mnemonic = null,
		SKImage?	icon = null )

Adds a command, preserving fluent construction. Gesture text overrides display-only shortcutText.

Parameters

text	The text to display.
action	The action.
shortcutText	The shortcut text.
enabled	Whether the feature is enabled.
key	The lookup key for the resource.
shortcut	The shortcut text displayed alongside the item.
mnemonic	The keyboard mnemonic used to activate the item.
icon	The icon.

Returns

This instance for fluent chaining.

Definition at line 95 of file MenuDropDownWidget.cs.

AddRadioItem()

MenuDropDownWidget Gondwana.Widgets.Menus.MenuDropDownWidget.AddRadioItem	(	string	text,
		Action?	action,
		string	group,
		bool	isChecked = false,
		bool	enabled = true,
		string?	key = null,
		KeyGesture?	shortcut = null,
		char?	mnemonic = null,
		SKImage?	icon = null )

Adds a radio command. Group names are scoped to this dropdown; the last checked item wins.

Parameters

text	The text to display.
action	The action.
group	The group.
isChecked	Whether the control starts or becomes checked.
enabled	Whether the feature is enabled.
key	The lookup key for the resource.
shortcut	The shortcut text displayed alongside the item.
mnemonic	The keyboard mnemonic used to activate the item.
icon	The icon.

Returns

This instance for fluent chaining.

Definition at line 133 of file MenuDropDownWidget.cs.

AddSeparator()

MenuDropDownWidget Gondwana.Widgets.Menus.MenuDropDownWidget.AddSeparator

(

)

Adds a visual separator.

Returns

This instance for fluent chaining.

Definition at line 294 of file MenuDropDownWidget.cs.

AddSubMenu()

MenuDropDownWidget Gondwana.Widgets.Menus.MenuDropDownWidget.AddSubMenu	(	string	text,
		Action< MenuDropDownWidget >	configure,
		bool	enabled = true,
		string?	key = null,
		char?	mnemonic = null,
		SKImage?	icon = null )

Adds an owned submenu. Submenus may themselves contain submenus to any depth.

Parameters

text	The text to display.
configure	The configure.
enabled	Whether the feature is enabled.
key	The lookup key for the resource.
mnemonic	The keyboard mnemonic used to activate the item.
icon	The icon.

Returns

This instance for fluent chaining.

Definition at line 151 of file MenuDropDownWidget.cs.

Dispose()

override void Gondwana.Widgets.Menus.MenuDropDownWidget.Dispose ( )

virtual

Disposes the composite and every child it owns.

Reimplemented from Gondwana.Drawing.Direct.DirectComposite.

Definition at line 450 of file MenuDropDownWidget.cs.

ProcessHidden()

override void Gondwana.Widgets.Menus.MenuDropDownWidget.ProcessHidden ( )

protectedvirtual

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

Reimplemented from Gondwana.Widgets.ContainerWidget.

Definition at line 282 of file MenuDropDownWidget.cs.

ProcessShown()

override void Gondwana.Widgets.Menus.MenuDropDownWidget.ProcessShown ( )

protectedvirtual

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

Reimplemented from Gondwana.Widgets.ContainerWidget.

Definition at line 274 of file MenuDropDownWidget.cs.

SetWidth()

MenuDropDownWidget Gondwana.Widgets.Menus.MenuDropDownWidget.SetWidth

(

int

width

)

Sets a fixed minimum width for this dropdown.

Parameters

width

The width.

Returns

This instance for fluent chaining.

Definition at line 320 of file MenuDropDownWidget.cs.

Property Documentation

Height

int Gondwana.Widgets.Menus.MenuDropDownWidget.Height

get

Gets the current popup height.

Definition at line 77 of file MenuDropDownWidget.cs.

IsOpen

bool Gondwana.Widgets.Menus.MenuDropDownWidget.IsOpen

get

Gets whether this dropdown accepts input. False while its close animation finishes.

Definition at line 80 of file MenuDropDownWidget.cs.

Items

IReadOnlyList<MenuItemWidget> Gondwana.Widgets.Menus.MenuDropDownWidget.Items

get

Gets the actionable entries in insertion order.

Definition at line 71 of file MenuDropDownWidget.cs.

Panel

DirectRectangle Gondwana.Widgets.Menus.MenuDropDownWidget.Panel

get

Gets the popup panel drawing.

Definition at line 68 of file MenuDropDownWidget.cs.

SelectedIndex

int Gondwana.Widgets.Menus.MenuDropDownWidget.SelectedIndex

get

Gets the selected actionable-item index, or -1.

Definition at line 83 of file MenuDropDownWidget.cs.

Width

int Gondwana.Widgets.Menus.MenuDropDownWidget.Width

get

Gets the current popup width.

Definition at line 74 of file MenuDropDownWidget.cs.