Class Widget

The base class of every user interface element.

Inheritance

object

Widget

ListAdapter<TContainerWidget, TViewHolder>

CodeEditor

ContainerWidget

ContentWidget

DropdownItemView<TItemType>

Dropdown<TItemType, TView>

Icon

Image

Label

Pressable

ProgressBar

ScrollBar

Slider

TextField

TextWidget

Toggle

Window

WindowCaptionButton

Avatar

CompositeIconWidget

DecorativeBlock

Emblem

ListItemWithHeader

TextScreen

CompletionListWidget

Cycler

SectionTitle

TwoLineListItemWithIcon

Implements

IFontFamilyProvider

IInspectable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Ritchie.Toolbox.Widgets

Assembly: Ritchie.Toolbox.dll

Syntax

public abstract class Widget : IFontFamilyProvider, IInspectable

Constructors

Widget()

Declaration

public Widget()

Properties

BackgroundStyle

Declaration

public Widget.BackgroundStyleProperties BackgroundStyle { get; set; }

Property Value

Type	Description
Widget.BackgroundStyleProperties

ChildCount

Declaration

public int ChildCount { get; }

Property Value

Type	Description
int

Children

Declaration

protected IOrderedCollection<Widget> Children { get; }

Property Value

Type	Description
IOrderedCollection<Widget>

ClipSelf

Declaration

public bool ClipSelf { get; set; }

Property Value

Type	Description
bool

ClippedContentArea

Declaration

public LayoutRect? ClippedContentArea { get; }

Property Value

Type	Description
LayoutRect?

ClippingMode

Declaration

public ClippingMode ClippingMode { get; set; }

Property Value

Type	Description
ClippingMode

ComputedOpacity

Declaration

public float ComputedOpacity { get; }

Property Value

Type	Description
float

ComputedPositionOffset

Declaration

public Point ComputedPositionOffset { get; }

Property Value

Type	Description
Point

ComputedTransformMatrix

Declaration

public Matrix ComputedTransformMatrix { get; }

Property Value

Type	Description
Matrix

Enabled

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
bool

GuiManager

Declaration

public virtual GuiManager? GuiManager { get; }

Property Value

Type	Description
GuiManager

HierarchyEnabled

Declaration

public bool HierarchyEnabled { get; }

Property Value

Type	Description
bool

HorizontalAlignment

Declaration

public HorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
HorizontalAlignment

IsChildFocused

Declaration

public bool IsChildFocused { get; }

Property Value

Type	Description
bool

IsFocused

Declaration

public bool IsFocused { get; }

Property Value

Type	Description
bool

IsLayoutValid

Declaration

public bool IsLayoutValid { get; }

Property Value

Type	Description
bool

IsVisible

Declaration

public bool IsVisible { get; }

Property Value

Type	Description
bool

LayoutArea

Declaration

public LayoutRect LayoutArea { get; }

Property Value

Type	Description
LayoutRect

LayoutRoot

Declaration

public Widget LayoutRoot { get; protected set; }

Property Value

Type	Description
Widget

Margin

Declaration

public Padding Margin { get; set; }

Property Value

Type	Description
Padding

MaximumHeight

Declaration

public int MaximumHeight { get; set; }

Property Value

Type	Description
int

MaximumSize

Declaration

public Point MaximumSize { get; set; }

Property Value

Type	Description
Point

MaximumWidth

Declaration

public int MaximumWidth { get; set; }

Property Value

Type	Description
int

MinimumHeight

Declaration

public int MinimumHeight { get; set; }

Property Value

Type	Description
int

MinimumSize

Declaration

public Point MinimumSize { get; set; }

Property Value

Type	Description
Point

MinimumWidth

Declaration

public int MinimumWidth { get; set; }

Property Value

Type	Description
int

Padding

Declaration

public Padding Padding { get; set; }

Property Value

Type	Description
Padding

PaintArea

Declaration

public LayoutRect PaintArea { get; }

Property Value

Type	Description
LayoutRect

Parent

Declaration

public Widget? Parent { get; }

Property Value

Type	Description
Widget

PopoverContent

Declaration

public PopoverContent? PopoverContent { get; set; }

Property Value

Type	Description
PopoverContent

PopoverLocation

Declaration

public PopoverLocationPreference PopoverLocation { get; set; }

Property Value

Type	Description
PopoverLocationPreference

PositionOffset

Declaration

public Point PositionOffset { get; set; }

Property Value

Type	Description
Point

RenderEffect

Declaration

public IWidgetEffect? RenderEffect { get; set; }

Property Value

Type	Description
IWidgetEffect

RenderOpacity

Declaration

public float RenderOpacity { get; set; }

Property Value

Type	Description
float

Root

Declaration

public Widget? Root { get; }

Property Value

Type	Description
Widget

Rotation

Declaration

public Quaternion Rotation { get; set; }

Property Value

Type	Description
Quaternion

Scale

Declaration

public Vector3 Scale { get; set; }

Property Value

Type	Description
Vector3

UniqueId

Declaration

public ulong UniqueId { get; }

Property Value

Type	Description
ulong

VerticalAlignment

Declaration

public VerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
VerticalAlignment

Visibility

Declaration

public Visibility Visibility { get; set; }

Property Value

Type	Description
Visibility

VisualStyleOverride

Declaration

public IVisualStyle? VisualStyleOverride { get; set; }

Property Value

Type	Description
IVisualStyle

Methods

ArrangeChildren(IGuiContext, LayoutRect)

Declaration

protected virtual void ArrangeChildren(IGuiContext context, LayoutRect availableSpace)

Parameters

Type	Name	Description
IGuiContext	context
LayoutRect	availableSpace

BeforeRender()

Declaration

protected virtual void BeforeRender()

BelongsToParent(Widget)

Declaration

public bool BelongsToParent(Widget widget)

Parameters

Type	Name	Description
Widget	widget

Returns

Type	Description
bool

ContainsChild(Widget?)

Declaration

public bool ContainsChild(Widget? widget)

Parameters

Type	Name	Description
Widget	widget

Returns

Type	Description
bool

EnumerateChildren()

Declaration

public IEnumerable<Widget> EnumerateChildren()

Returns

Type	Description
IEnumerable<Widget>

GetCachedContentSize(Point)

Declaration

public Point GetCachedContentSize(Point availableSize)

Parameters

Type	Name	Description
Point	availableSize

Returns

Type	Description
Point

GetContentSize(Point)

Declaration

protected virtual Point GetContentSize(Point availableSize)

Parameters

Type	Name	Description
Point	availableSize

Returns

Type	Description
Point

GetCustomProperties<T>()

Declaration

public T GetCustomProperties<T>() where T : CustomPropertyObject

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetCustomProperty<T>()

Declaration

public T GetCustomProperty<T>() where T : struct

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetFont(PresetFontFamily)

Declaration

public IFontFamily GetFont(PresetFontFamily family)

Parameters

Type	Name	Description
PresetFontFamily	family

Returns

Type	Description
IFontFamily

GetTextColor(ref Color, Color?)

Declaration

protected bool GetTextColor(ref Color color, Color? fallbackColor = null)

Parameters

Type	Name	Description
Color	color
Color?	fallbackColor

Returns

Type	Description
bool

GetThemeProperties<TThemeProperties>(ref TThemeProperties, InvalidationMode)

Declaration

protected void GetThemeProperties<TThemeProperties>(ref TThemeProperties properties, InvalidationMode invalidationMode = InvalidationMode.LayoutAndGeometry) where TThemeProperties : struct

Parameters

Type	Name	Description
TThemeProperties	properties
InvalidationMode	invalidationMode

Type Parameters

Name	Description
TThemeProperties

GetVisualStyleOverride()

Walks up the widget tree from this widget to the top-level, returning the first visual style override that isn't null. If no widgets in the path override the global visual style, then null will be returned.

Declaration

public IVisualStyle? GetVisualStyleOverride()

Returns

Type	Description
IVisualStyle	The visual style override for this widget or one of its parents, or null if there are no overriding widgets.

GiveFocus()

Declaration

public void GiveFocus()

Inspect(IInspector)

Declaration

public virtual void Inspect(IInspector inspector)

Parameters

Type	Name	Description
IInspector	inspector

Invalidate(InvalidationMode)

Declaration

public void Invalidate(InvalidationMode invalidationMode)

Parameters

Type	Name	Description
InvalidationMode	invalidationMode

InvalidateClipping(bool)

Declaration

public void InvalidateClipping(bool recursive = false)

Parameters

Type	Name	Description
bool	recursive

InvalidateGeometry(bool)

Declaration

public void InvalidateGeometry(bool invalidateChildren = false)

Parameters

Type	Name	Description
bool	invalidateChildren

InvalidateLayout()

Declaration

public void InvalidateLayout()

InvalidateOwnLayout()

Declaration

public void InvalidateOwnLayout()

IsInsideClipRegion(Point)

Declaration

public bool IsInsideClipRegion(Point point)

Parameters

Type	Name	Description
Point	point

Returns

Type	Description
bool

RebuildClippingZone(GeometryHelper)

Declaration

protected virtual void RebuildClippingZone(GeometryHelper geometry)

Parameters

Type	Name	Description
GeometryHelper	geometry

RebuildGeometry(GeometryHelper)

Declaration

protected virtual void RebuildGeometry(GeometryHelper geometry)

Parameters

Type	Name	Description
GeometryHelper	geometry

SendSignal<TSignal>(TSignal, SignalDirection)

Send a signal of type TSignal from this widget.

Declaration

protected bool SendSignal<TSignal>(TSignal signal, SignalDirection direction = SignalDirection.Up)

Parameters

Type	Name	Description
TSignal	signal	The signal to send.
SignalDirection	direction	A value indicating where to send the signal.

Returns

Type	Description
bool	True if the signal was handled, false otherwise.

Type Parameters

Name	Description
TSignal	The type of signal to send.

SetCustomProperty<T>(T)

Declaration

public void SetCustomProperty<T>(T newValue) where T : struct

Parameters

Type	Name	Description
T	newValue

Type Parameters

Name	Description
T

ShouldRenderChild(Widget)

Declaration

protected virtual bool ShouldRenderChild(Widget childWidget)

Parameters

Type	Name	Description
Widget	childWidget

Returns

Type	Description
bool

UpdateLayout(IGuiContext, LayoutRect)

Declaration

public void UpdateLayout(IGuiContext context, LayoutRect availableSpace)

Parameters

Type	Name	Description
IGuiContext	context
LayoutRect	availableSpace

Events

WidgetRepainting

Declaration

public static event Action<Widget, LayoutRect>? WidgetRepainting

Event Type

Type	Description
Action<Widget, LayoutRect>

Implements

IFontFamilyProvider

IInspectable

Extension Methods

AnimationExtensions.RenderOpacityFade(Widget, float, float, CurveFunction?)