Class ThemeStates
Has the basic appearances of each control state.
Inherited Members
Namespace: SadConsole.UI
Assembly: SadConsole.dll
Syntax
[DataContract]
public class ThemeStates
Constructors
ThemeStates()
Declaration
public ThemeStates()
Properties
Disabled
The appearance of the control when it is disabled.
Declaration
[DataMember]
public ColoredGlyphBase Disabled { get; set; }
Property Value
Type | Description |
---|---|
ColoredGlyphBase |
Focused
The appearance of the control when it is focused.
Declaration
[DataMember]
public ColoredGlyphBase Focused { get; set; }
Property Value
Type | Description |
---|---|
ColoredGlyphBase |
MouseDown
THe appearance of the control when a mouse button is held down.
Declaration
[DataMember]
public ColoredGlyphBase MouseDown { get; set; }
Property Value
Type | Description |
---|---|
ColoredGlyphBase |
MouseOver
The appearance of the control when the mouse is over it.
Declaration
[DataMember]
public ColoredGlyphBase MouseOver { get; set; }
Property Value
Type | Description |
---|---|
ColoredGlyphBase |
Normal
The normal appearance of the control.
Declaration
[DataMember]
public ColoredGlyphBase Normal { get; set; }
Property Value
Type | Description |
---|---|
ColoredGlyphBase |
Selected
The appearance of the control when it is in a selected state.
Declaration
[DataMember]
public ColoredGlyphBase Selected { get; set; }
Property Value
Type | Description |
---|---|
ColoredGlyphBase |
Methods
Clone()
Performs a deep copy of this theme.
Declaration
public ThemeStates Clone()
Returns
Type | Description |
---|---|
ThemeStates | A new instance of the theme. |
GetStateAppearance(ControlStates)
Gets an appearance defined by this theme from the state
parameter.
Declaration
public ColoredGlyphBase GetStateAppearance(ControlStates state)
Parameters
Type | Name | Description |
---|---|---|
ControlStates | state | The state to check. |
Returns
Type | Description |
---|---|
ColoredGlyphBase | A cell appearance. |
GetStateAppearanceNoMouse(ControlStates)
Gets an appearance defined by this theme from the state
parameter. Treats mouse related states as normal.
Declaration
public ColoredGlyphBase GetStateAppearanceNoMouse(ControlStates state)
Parameters
Type | Name | Description |
---|---|---|
ControlStates | state | The state to check. |
Returns
Type | Description |
---|---|
ColoredGlyphBase | A cell appearance. |
RefreshTheme(Colors)
Reloads the theme values based on the colors provided.
Declaration
public virtual void RefreshTheme(Colors colors)
Parameters
Type | Name | Description |
---|---|---|
Colors | colors | The colors to create the theme with. |
SetBackground(Color)
Sets the same background color to all theme states.
Declaration
public void SetBackground(Color color)
Parameters
Type | Name | Description |
---|---|---|
Color | color | The background color. |
SetForeground(Color)
Sets the same foreground color to all theme states.
Declaration
public void SetForeground(Color color)
Parameters
Type | Name | Description |
---|---|---|
Color | color | The foreground color. |
SetGlyph(int)
Sets the same glyph to all theme states.
Declaration
public void SetGlyph(int glyph)
Parameters
Type | Name | Description |
---|---|---|
int | glyph | The glyph. |
SetMirror(Mirror)
Sets the same mirror setting to all theme states.
Declaration
public void SetMirror(Mirror mirror)
Parameters
Type | Name | Description |
---|---|---|
Mirror | mirror | The mirror setting. |