Represents one selectable page owned by a TabControlWidget. More...

Inheritance diagram for Gondwana.Widgets.Controls.TabPageWidget:

Public Member Functions

TabPageWidget AddWidget (WidgetBase widget, Point? offsetPx=null)

Adds a widget at an offset from the page content area's upper-left corner.

TabPageWidget RemoveWidget (WidgetBase widget, bool dispose=false)

Removes a child widget from the page.

TabPageWidget SetTitle (string title)

Changes the title displayed by the owning tab control.

TabPageWidget SetBackgroundColor (Color color)

Sets the page background fill color.

TabPageWidget SetBorderColor (Color color)

Sets the page border color.

TabPageWidget SetStrokeWidth (float width)

Sets the page border width.

TabPageWidget SetCornerRadius (float radius)

Sets the page corner radius.

TabPageWidget SetBackgroundImage (SKBitmap bitmap, DirectRectangle.ImageFillMode mode=DirectRectangle.ImageFillMode.Stretch, float scale=1f, SKPoint? offsetPx=null, SKFilterQuality filterQuality=SKFilterQuality.Medium)

Uses a bitmap as the page background.

TabPageWidget SetBackgroundImage (SKImage image, DirectRectangle.ImageFillMode mode=DirectRectangle.ImageFillMode.Stretch, float scale=1f, SKPoint? offsetPx=null, SKFilterQuality filterQuality=SKFilterQuality.Medium)

Uses an image as the page background.

TabPageWidget ClearBackgroundImage ()

Removes an image background and restores the configured color fill.

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.

virtual void Dispose ()

Disposes the composite and every child it owns.

Properties
DirectRectangle	Background `[get]`
	Gets the direct rectangle used for this page's content background.
string	Title `[get]`
	Gets the title displayed by the page's tab header.
char?	Mnemonic `[get]`
	Gets the optional Alt-key mnemonic that selects this page.
Rectangle	ContentBounds `[get]`
	Gets the page's content bounds in its native coordinate space.
Rectangle	HeaderBounds `[get, set]`
	Gets the bounds occupied by this page's tab header in its native coordinate space.
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

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.

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 one selectable page owned by a TabControlWidget.

Create pages with TabControlWidget.AddTab(string,char?,string?). The page owns the widgets placed in its content area and is shown only while it is the selected page of its owning tab control.

Definition at line 17 of file TabPageWidget.cs.

Member Function Documentation

◆ AddWidget()

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.AddWidget	(	WidgetBase	widget,
		Point?	offsetPx = null )

Adds a widget at an offset from the page content area's upper-left corner.

Parameters

widget	The widget to add.
offsetPx	The local content offset, or `null` for the origin.

Returns: The current page.

Definition at line 127 of file TabPageWidget.cs.

◆ ClearBackgroundImage()

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.ClearBackgroundImage ( )

Removes an image background and restores the configured color fill.

Returns: The current page.

Definition at line 266 of file TabPageWidget.cs.

◆ RemoveWidget()

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.RemoveWidget	(	WidgetBase	widget,
		bool	dispose = false )

Removes a child widget from the page.

Parameters

widget	The widget to remove.
dispose	Whether to dispose the widget after removing it.

Returns: The current page.

Definition at line 147 of file TabPageWidget.cs.

◆ SetBackgroundColor()

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.SetBackgroundColor ( Color color )

Sets the page background fill color.

Parameters

color The new background color.

Returns: The current page.

Definition at line 175 of file TabPageWidget.cs.

◆ SetBackgroundImage() [1/2]

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.SetBackgroundImage	(	SKBitmap	bitmap,
		DirectRectangle.ImageFillMode	mode = DirectRectangle::ImageFillMode::Stretch,
		float	scale = 1f,
		SKPoint?	offsetPx = null,
		SKFilterQuality	filterQuality = SKFilterQuality::Medium )

Uses a bitmap as the page background.

Parameters

bitmap	The source bitmap.
mode	How the bitmap fills the page.
scale	The bitmap scale.
offsetPx	The optional bitmap offset.
filterQuality	The sampling quality.

Returns: The current page.

Definition at line 233 of file TabPageWidget.cs.

◆ SetBackgroundImage() [2/2]

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.SetBackgroundImage	(	SKImage	image,
		DirectRectangle.ImageFillMode	mode = DirectRectangle::ImageFillMode::Stretch,
		float	scale = 1f,
		SKPoint?	offsetPx = null,
		SKFilterQuality	filterQuality = SKFilterQuality::Medium )

Uses an image as the page background.

Parameters

image	The source image.
mode	How the image fills the page.
scale	The image scale.
offsetPx	The optional image offset.
filterQuality	The sampling quality.

Returns: The current page.

Definition at line 252 of file TabPageWidget.cs.

◆ SetBorderColor()

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.SetBorderColor ( Color color )

Sets the page border color.

Parameters

color The new border color.

Returns: The current page.

Definition at line 187 of file TabPageWidget.cs.

◆ SetCornerRadius()

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.SetCornerRadius ( float radius )

Sets the page corner radius.

Parameters

radius The non-negative corner radius.

Returns: The current page.

Definition at line 214 of file TabPageWidget.cs.

◆ SetStrokeWidth()

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.SetStrokeWidth ( float width )

Sets the page border width.

Parameters

width The non-negative border width.

Returns: The current page.

Definition at line 199 of file TabPageWidget.cs.

◆ SetTitle()

TabPageWidget Gondwana.Widgets.Controls.TabPageWidget.SetTitle ( string title )

Changes the title displayed by the owning tab control.

Parameters

title The new non-empty title.

Returns: The current page.

Definition at line 159 of file TabPageWidget.cs.

Property Documentation

◆ Background

DirectRectangle Gondwana.Widgets.Controls.TabPageWidget.Background

get

Gets the direct rectangle used for this page's content background.

Definition at line 97 of file TabPageWidget.cs.

◆ ContentBounds

Rectangle Gondwana.Widgets.Controls.TabPageWidget.ContentBounds

get

Gets the page's content bounds in its native coordinate space.

Definition at line 112 of file TabPageWidget.cs.

◆ HeaderBounds

Rectangle Gondwana.Widgets.Controls.TabPageWidget.HeaderBounds

getset

Gets the bounds occupied by this page's tab header in its native coordinate space.

Definition at line 119 of file TabPageWidget.cs.

◆ Mnemonic

char? Gondwana.Widgets.Controls.TabPageWidget.Mnemonic

get

Gets the optional Alt-key mnemonic that selects this page.

Definition at line 107 of file TabPageWidget.cs.

◆ Title

string Gondwana.Widgets.Controls.TabPageWidget.Title

get

Gets the title displayed by the page's tab header.

Definition at line 102 of file TabPageWidget.cs.

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddWidget()

◆ ClearBackgroundImage()

◆ RemoveWidget()

◆ SetBackgroundColor()

◆ SetBackgroundImage() [1/2]

◆ SetBackgroundImage() [2/2]

◆ SetBorderColor()

◆ SetCornerRadius()

◆ SetStrokeWidth()

◆ SetTitle()

Property Documentation

◆ Background

◆ ContentBounds

◆ HeaderBounds

◆ Mnemonic

◆ Title