Class WindowCaptionButton

A widget for the various buttons inside a Window's titlebar.

Inheritance
object
Widget
WindowCaptionButton
Implements
Inherited Members
Namespace: SociallyDistant.Core.Shell.Windowing
Assembly: SociallyDistant.Framework.dll
Syntax
public sealed class WindowCaptionButton : Widget, IFontFamilyProvider, IInspectable, IUpdateThemeProperties, IMouseEnterHandler, IMouseLeaveHandler, IMouseDownHandler, IMouseUpHandler, IMouseClickHandler, IMouseHandler, IVisual<WindowCaptionButton.VisualState>

Properties

CaptionButtonMode

Gets or sets the visual mode of the caption button.

Declaration
public CaptionButtonStyle CaptionButtonMode { get; set; }
Property Value
Type Description
CaptionButtonStyle

Type

Gets or sets the type of the caption button. This value determines what it looks like.

Declaration
public CaptionButtonType Type { get; set; }
Property Value
Type Description
CaptionButtonType

VisualProperties

Gets a read-only reference to the visual properties associated with the widget.

Declaration
public ref readonly WindowCaptionButton.VisualState VisualProperties { get; }
Property Value
Type Description
WindowCaptionButton.VisualState

Methods

BeforeRender()

Declaration
protected override void BeforeRender()
Overrides

GetContentSize(Point)

Declaration
protected override Point GetContentSize(Point availableSize)
Parameters
Type Name Description
Point availableSize
Returns
Type Description
Point
Overrides

OnMouseClick(MouseButtonEvent)

Declaration
public void OnMouseClick(MouseButtonEvent e)
Parameters
Type Name Description
MouseButtonEvent e

OnMouseDown(MouseButtonEvent)

Declaration
public void OnMouseDown(MouseButtonEvent e)
Parameters
Type Name Description
MouseButtonEvent e

OnMouseEnter(MouseMoveEvent)

Declaration
public void OnMouseEnter(MouseMoveEvent e)
Parameters
Type Name Description
MouseMoveEvent e

OnMouseLeave(MouseMoveEvent)

Declaration
public void OnMouseLeave(MouseMoveEvent e)
Parameters
Type Name Description
MouseMoveEvent e

OnMouseUp(MouseButtonEvent)

Declaration
public void OnMouseUp(MouseButtonEvent e)
Parameters
Type Name Description
MouseButtonEvent e

RebuildGeometry(GeometryHelper)

Declaration
protected override void RebuildGeometry(GeometryHelper geometry)
Parameters
Type Name Description
GeometryHelper geometry
Overrides

UpdateThemeProperties()

Retrieves layout properties from the visual style. Called by the UI system on every frame before layout updates occur. If layout properties change during this method call, the widget will automatically invalidate its own layout.

Declaration
public void UpdateThemeProperties()

Events

Clicked

Event that fires when the caption button is clicked.

Declaration
public event Action? Clicked
Event Type
Type Description
Action

Implements