ControlBase Class
Definition
Section titled “Definition”Base class for all controls.
[DataContract]public abstract class ControlBaseInheritance object
Constructors
Section titled “Constructors”ControlBase(int, int)
Section titled “ControlBase(int, int)”Creates a control.
protected ControlBase(int width, int height)Parameters
Section titled “Parameters”width int
height int
Fields
Section titled “Fields”MouseState_IsMouseOver
Section titled “MouseState_IsMouseOver”A cached value determined by OnMouseEnter(ControlMouseState). true when the mouse is over the bounds defined by MouseArea .
protected bool MouseState_IsMouseOverMouseState_EnteredWithButtonDown
Section titled “MouseState_EnteredWithButtonDown”A cached value determined by OnMouseEnter(ControlMouseState). true when the mouse entered the control’s bounds with the mouse button down.
protected bool MouseState_EnteredWithButtonDownMouseState_IsMouseLeftDown
Section titled “MouseState_IsMouseLeftDown”A cached value determined by OnMouseIn(ControlMouseState). true when the left mouse button is down.
protected bool MouseState_IsMouseLeftDownMouseState_IsMouseRightDown
Section titled “MouseState_IsMouseRightDown”A cached value determined by OnMouseIn(ControlMouseState). true when the right mouse button is down.
protected bool MouseState_IsMouseRightDownProperties
Section titled “Properties”ThemeState
Section titled “ThemeState”The theme of the control based on its state.
public ThemeStates ThemeState { get; set; }UseKeyboard
Section titled “UseKeyboard”true to allow this control to respond to keyboard interactions when focused.
[DataMember]public bool UseKeyboard { get; set; }UseMouse
Section titled “UseMouse”true to allow this control to respond to mouse interactions.
[DataMember]public bool UseMouse { get; set; }CanFocus
Section titled “CanFocus”true to indicate this control can be focused, generally by clicking on the control or tabbing with the keyboard. Otherwise false.
[DataMember]public bool CanFocus { get; set; }CanResize
Section titled “CanResize”When true, indicates that this control can be resized with the Resize(int, int) method; otherwise false.
[DataMember]public bool CanResize { get; protected set; }AlternateFont
Section titled “AlternateFont”An alternate font used to render this control.
[DataMember]public IFont? AlternateFont { get; set; }Surface
Section titled “Surface”The cell data to render the control. Controlled by a theme.
public ICellSurface Surface { get; set; }MouseArea
Section titled “MouseArea”The relative region the of the control used for mouse input.
[DataMember]public Rectangle MouseArea { get; set; }IsMouseButtonStateClean
Section titled “IsMouseButtonStateClean”When true, indicates the mouse button state has only been set with this control and not another; otherwise false.
public bool IsMouseButtonStateClean { get; }Remarks
Section titled “Remarks”This property is only set when the mouse enters the control with the buttons pressed. Once the buttons are let go, the mouse is considered clean for this control.
Position
Section titled “Position”The relative position of this control.
[DataMember]public Point Position { get; set; }AbsolutePosition
Section titled “AbsolutePosition”Gets the position of this control based on the control’s Position and the position of the Parent.
public Point AbsolutePosition { get; }IsVisible
Section titled “IsVisible”Indicates whether or not this control is visible.
[DataMember]public bool IsVisible { get; set; }A user-definable data object.
public object? Tag { get; set; }TabStop
Section titled “TabStop”Indicates whether or not this control can be tabbed to.
[DataMember]public bool TabStop { get; set; }TabIndex
Section titled “TabIndex”Sets the tab index of this control.
[DataMember]public int TabIndex { get; set; }IsDirty
Section titled “IsDirty”Indicates whether or not this control is dirty and should be redrawn.
public bool IsDirty { get; set; }Represents a name to identify a control by.
[DataMember]public string? Name { get; init; }FocusOnMouseClick
Section titled “FocusOnMouseClick”Gets or sets whether or not this control will become focused when the mouse is clicked.
[DataMember]public bool FocusOnMouseClick { get; set; }The width of the control.
public int Width { get; protected set; }Height
Section titled “Height”The height of the control.
public int Height { get; protected set; }IsFocused
Section titled “IsFocused”Gets or sets whether or not this control is focused.
public bool IsFocused { get; set; }IsEnabled
Section titled “IsEnabled”Gets or sets whether or not this control is enabled.
[DataMember]public bool IsEnabled { get; set; }Bounds
Section titled “Bounds”The area of the host this control covers.
public Rectangle Bounds { get; }Parent
Section titled “Parent”Gets or sets the parent container of this control.
public IContainer? Parent { get; set; }The state of the control.
public ControlStates State { get; protected set; }Methods
Section titled “Methods”OnUnfocused()
Section titled “OnUnfocused()”Called when the control loses focus.
protected virtual void OnUnfocused()OnFocused()
Section titled “OnFocused()”Called when the control is focused.
protected virtual void OnFocused()OnIsDirtyChanged()
Section titled “OnIsDirtyChanged()”Called when the IsDirty property changes value.
protected virtual void OnIsDirtyChanged()ProcessKeyboard(Keyboard)
Section titled “ProcessKeyboard(Keyboard)”Called when the keyboard is used on this control.
public virtual bool ProcessKeyboard(Keyboard state)Parameters
Section titled “Parameters”state Keyboard
The state of the keyboard.
Returns
Section titled “Returns”ProcessMouse(MouseScreenObjectState)
Section titled “ProcessMouse(MouseScreenObjectState)”Checks if the mouse is the control and calls the appropriate mouse methods.
public virtual bool ProcessMouse(MouseScreenObjectState state)Parameters
Section titled “Parameters”state MouseScreenObjectState
Mouse information.
Returns
Section titled “Returns”bool
True when the control is enabled, set to use the mouse and the mouse is over it, otherwise false.
LostMouse(MouseScreenObjectState)
Section titled “LostMouse(MouseScreenObjectState)”Called to trigger the state of losing mouse focus.
public void LostMouse(MouseScreenObjectState state)Parameters
Section titled “Parameters”state MouseScreenObjectState
The mouse state.
OnParentChanged()
Section titled “OnParentChanged()”Called when the parent property is changed.
protected virtual void OnParentChanged()OnPositionChanged()
Section titled “OnPositionChanged()”Called when the control changes position.
protected virtual void OnPositionChanged()PlaceRelativeTo(ControlBase, Types, int)
Section titled “PlaceRelativeTo(ControlBase, Types, int)”Places this control relative to another, taking into account the bounds of the control.
public void PlaceRelativeTo(ControlBase control, Direction.Types direction, int padding = 1)Parameters
Section titled “Parameters”control ControlBase
The other control to place this one relative to.
direction SadRogue.Primitives.Direction.Types
The direction this control should be placed.
padding int
Additional space between the controls after placement.
Remarks
Section titled “Remarks”If this control hasn’t been added to the parent of control, it will be added.
DetermineState()
Section titled “DetermineState()”Sets the appropriate theme for the control based on the current state of the control.
public virtual void DetermineState()Remarks
Section titled “Remarks”Called by the control as the mouse state changes, like when the mouse is clicked on top of the control or leaves the area of the control. This method is implemented by each derived control.
OnStateChanged(ControlStates, ControlStates)
Section titled “OnStateChanged(ControlStates, ControlStates)”Called when the State changes. Sets the IsDirty to true.
protected virtual void OnStateChanged(ControlStates oldState, ControlStates newState)Parameters
Section titled “Parameters”oldState ControlStates
The original state.
newState ControlStates
The new state.
OnSurfaceChanged(ICellSurface, ICellSurface)
Section titled “OnSurfaceChanged(ICellSurface, ICellSurface)”Called when the Surface property is set.
protected virtual void OnSurfaceChanged(ICellSurface oldSurface, ICellSurface newSurface)Parameters
Section titled “Parameters”oldSurface ICellSurface
The previous surface instance.
newSurface ICellSurface
The new surface instance.
FindThemeFont()
Section titled “FindThemeFont()”Returns the AlternateFont. If null, returns the host’s console font or the default engine font.
public IFont FindThemeFont()Returns
Section titled “Returns”FindThemeColors()
Section titled “FindThemeColors()”Returns the colors assigned to this control, the parent, or the library default.
public Colors FindThemeColors()Returns
Section titled “Returns”Colors
The found colors.
SetThemeColors(Colors?)
Section titled “SetThemeColors(Colors?)”Sets the theme colors used by this control. When null, indicates this control should read the theme colors from the parent.
public void SetThemeColors(Colors? value)Parameters
Section titled “Parameters”value Colors
The colors to use with this control.
HasThemeColors()
Section titled “HasThemeColors()”When true, indicates the control has custom theme colors assigned to it; othwerise false.
public bool HasThemeColors()Returns
Section titled “Returns”Resize(int, int)
Section titled “Resize(int, int)”Resizes the control if the CanResize property is true.
public virtual void Resize(int width, int height)Parameters
Section titled “Parameters”width int
The desired width of the control.
height int
The desired height of the control.
OnResized()
Section titled “OnResized()”Called when Resize(int, int) was called.
protected virtual void OnResized()CreateControlSurface()
Section titled “CreateControlSurface()”Generates the surface to be used by this control. This method is called internally to assign the Surface property a value.
protected virtual ICellSurface CreateControlSurface()Returns
Section titled “Returns”ICellSurface
A surface that should be assigned to the Surface property.
RefreshThemeStateColors(Colors)
Section titled “RefreshThemeStateColors(Colors)”Updates the ThemeState by calling RefreshTheme(Colors) with the provided colors. Override this method to adjust how colors are used by the ThemeState.
protected virtual void RefreshThemeStateColors(Colors colors)Parameters
Section titled “Parameters”colors Colors
The colors to apply to the theme state.
OnMouseEnter(ControlMouseState)
Section titled “OnMouseEnter(ControlMouseState)”Called when the mouse first enters the control. Raises the MouseEnter event and calls the DetermineState() method.
protected virtual void OnMouseEnter(ControlBase.ControlMouseState state)Parameters
Section titled “Parameters”state ControlBase.ControlMouseState
The current mouse data
OnMouseExit(ControlMouseState)
Section titled “OnMouseExit(ControlMouseState)”Called when the mouse exits the area of the control. Raises the MouseExit event and calls the DetermineState() method.
protected virtual void OnMouseExit(ControlBase.ControlMouseState state)Parameters
Section titled “Parameters”state ControlBase.ControlMouseState
The current mouse data
OnMouseIn(ControlMouseState)
Section titled “OnMouseIn(ControlMouseState)”Called as the mouse moves around the control area. Raises the MouseMove event and calls the DetermineState() method.
protected virtual void OnMouseIn(ControlBase.ControlMouseState state)Parameters
Section titled “Parameters”state ControlBase.ControlMouseState
The current mouse data
OnLeftMouseClicked(ControlMouseState)
Section titled “OnLeftMouseClicked(ControlMouseState)”Called when the left mouse button is clicked. Raises the MouseButtonClicked event and calls the DetermineState() method.
protected virtual void OnLeftMouseClicked(ControlBase.ControlMouseState state)Parameters
Section titled “Parameters”state ControlBase.ControlMouseState
The current mouse data
OnRightMouseClicked(ControlMouseState)
Section titled “OnRightMouseClicked(ControlMouseState)”Called when the right mouse button is clicked. Raises the MouseButtonClicked event and calls the DetermineState() method.
protected virtual void OnRightMouseClicked(ControlBase.ControlMouseState state)Parameters
Section titled “Parameters”state ControlBase.ControlMouseState
The current mouse data.
UpdateAndRedraw(TimeSpan)
Section titled “UpdateAndRedraw(TimeSpan)”Redraws the control if applicable.
public abstract void UpdateAndRedraw(TimeSpan time)Parameters
Section titled “Parameters”time TimeSpan
The duration of thecurrent frame.
Events
Section titled “Events”IsDirtyChanged
Section titled “IsDirtyChanged”Raised when the IsDirty property changes.
public event EventHandler<EventArgs>? IsDirtyChangedEvent Type
Section titled “Event Type”Focused
Section titled “Focused”Raised when the IsFocused is set to true.
public event EventHandler<EventArgs>? FocusedEvent Type
Section titled “Event Type”Unfocused
Section titled “Unfocused”Raised when the IsFocused is set to false.
public event EventHandler<EventArgs>? UnfocusedEvent Type
Section titled “Event Type”PositionChanged
Section titled “PositionChanged”Raised when the Position property changes value.
public event EventHandler<EventArgs>? PositionChangedEvent Type
Section titled “Event Type”MouseEnter
Section titled “MouseEnter”Raised when the mouse enters this control.
public event EventHandler<ControlBase.ControlMouseState>? MouseEnterEvent Type
Section titled “Event Type”EventHandler<ControlBase.ControlMouseState>
MouseExit
Section titled “MouseExit”Raised when the mouse exits this control.
public event EventHandler<ControlBase.ControlMouseState>? MouseExitEvent Type
Section titled “Event Type”EventHandler<ControlBase.ControlMouseState>
MouseMove
Section titled “MouseMove”Raised when the mouse is moved over this control.
public event EventHandler<ControlBase.ControlMouseState>? MouseMoveEvent Type
Section titled “Event Type”EventHandler<ControlBase.ControlMouseState>
MouseButtonClicked
Section titled “MouseButtonClicked”Raised when a mouse button is clicked while the mouse is over this control.
public event EventHandler<ControlBase.ControlMouseState>? MouseButtonClicked