Skip to content

ColorScheme

Jump to bottom
JaykeBird edited this page Feb 21, 2023 · 9 revisions

Back to home | Back to Reference | View raw text

ColorScheme class

Description

A collection of colors and other settings that can be used to set the color and appearance of various Solid Shine UI controls.

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph SolidShineUi
  SolidShineUi.ColorScheme[[ColorScheme]]
  end
Loading

Members

Properties

Public properties

Type Name Methods
Color AccentBackgroundColor
The primary background accent color of a window or pane.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color AccentBorderColor
The accent color used for the borders of elements and windows.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color AccentHighlightColor
The accent color used for when certain elements have focus or have the mouse over them; this is a darker color than the main color, and is generally used for the caption buttons of a window.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color AccentLightBackgroundColor
The accent color used for the background of certain elements. This background color is lighter than the main background color.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color AccentMainColor
This is the main interface accent color, and generally the most vibrant. With High Contrast color schemes, this will be the same as AccentBackgroundColor.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color AccentSecondHighlightColor
The accent color used for when certain elements have focus or have the mouse over them; this is a lighter color than the main color, and is generally used by many UI elements.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color AccentSecondaryColor
This is the secondary interface accent color, which can be used to differentiate regions of a user interface by color.
Do not use this with High Contrast color schemes (use ColorScheme.IsHighContrast to check if this color scheme is a high contrast theme.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color AccentSelectionColor
The accent color used for when certain elements are being clicked on; this a darker color than the main color, and is generally used for the caption buttons of a window.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color AccentThirdHighlightColor
The accent color used for when certain elements are being clicked on; this is a lighter color than the main color, and is generally used by many UI elements.
Accent colors can be used wherever you wish to add more contrasting color to your UI.		 get, set
Color BackgroundColor
The primary background color of a window or pane.		 get, set
Color BorderColor
The color used for the borders of elements and windows.		 get, set
Color DarkDisabledColor
The color to display for items that are disabled or not usable. This color is primarily used for the borders and foregrounds of disabled elements.		 get, set
Color ForegroundColor
The main color used for foreground elements, such as text. Ideally, this color should contrast greatly against the background colors and also the main color.		 get, set
Color HighlightColor
The color used for when certain elements have focus or have the mouse over them; this is a darker color than the main color, and is generally used for the caption buttons of a window.		 get, set
bool IsHighContrast
Get or set whether this is a high-contrast color scheme. Some controls will differ their appearnce if this color scheme is a high contrast one.		 get, set
Color ItemColor
This color is not used in Solid Shine UI, and is included for backwards compatibility reasons. You can utilize this color for your own custom needs, if desired.		 get, set
Color LightBackgroundColor
The color used for the background of certain elements. This background color is lighter than the main background color.		 get, set
Color LightDisabledColor
The color to display for items that are disabled or not usable. This color is primarily used for the backgrounds of disabled elements.		 get, set
Color MainColor
This is the main interface color, and generally the most vibrant. Despite the name, this color should not be used too commonly. With High Contrast color schemes, this will be the same as BackgroundColor.		 get, set
bool MenusUseAccent
Determine if menus should use some accent colors while highlighting items.		 get, set
Color SecondHighlightColor
The color used for when certain elements have focus or have the mouse over them; this is a lighter color than the main color, and is generally used by many UI elements.		 get, set
Color SecondaryColor
This is the secondary interface color, which can be used to differentiate regions of a user interface by color.
Do not use this with High Contrast color schemes (use ColorScheme.IsHighContrast to check if this color scheme is a high contrast theme.		 get, set
Color SelectionColor
The color used for when certain elements are being clicked on; this a darker color than the main color, and is generally used for the caption buttons of a window.		 get, set
Color ThirdHighlightColor
The color used for when certain elements are being clicked on; this is a lighter color than the main color, and is generally used by many UI elements.		 get, set
Color WindowInactiveColor
This color is used for the titlebar of windows, while they are inactive (as in, does not have focus).		 get, set
Color WindowTitleBarColor
This color is used for the title bar of windows, while they are active (as in, in the foreground and with focus).		 get, set
Color WindowTitleBarTextColor
This color is used for the text in the title bar of windows, as well as for the caption buttons' icons.		 get, set

Methods

Public Static methods

Returns Name
ColorScheme CreateDarkTheme(...)
Create a premade dark theme color scheme. Darker gray colors are used.
ColorScheme CreateLightTheme(...)
Create a premade light theme color scheme. Lighter gray colors are used.
ColorScheme GetHighContrastScheme(HighContrastOption hco)
Create a color scheme with high-contrast colors, based upon one of the available options.

Details

Summary

A collection of colors and other settings that can be used to set the color and appearance of various Solid Shine UI controls.

Constructors

ColorScheme [1/3]

public ColorScheme()
Summary

Create a color scheme with no colors preset; default values are all grey. Can be used to custom build a scheme color by color.

ColorScheme [2/3]

public ColorScheme(Color mainColor)
Arguments
Type Name Description
Color mainColor The main base color for this color scheme.
Summary

Create a color scheme with a single preset color as the basis. All other colors in the scheme are based off this color.

ColorScheme [3/3]

public ColorScheme(Color mainColor, Color accentColor)
Arguments
Type Name Description
Color mainColor The main base color for this color scheme.
Color accentColor The base color to use as the accent color for this color scheme.
Summary

Create a color scheme with a preset color for the basis, and an additional preset color to use as a secondary accent. All other colors are based off one of these two colors.

Methods

CreateLightTheme [1/2]

public static ColorScheme CreateLightTheme()
Summary

Create a premade light theme color scheme. Lighter gray colors are used.

Returns

CreateLightTheme [2/2]

public static ColorScheme CreateLightTheme(Color accentColor)
Arguments
Type Name Description
Color accentColor The accent color to use with the light theme, to add more color to certain elements.
Summary

Create a premade light theme color scheme. Lighter gray colors are used, and a custom accent color can be provided to add some more color.

Returns

CreateDarkTheme [1/2]

public static ColorScheme CreateDarkTheme()
Summary

Create a premade dark theme color scheme. Darker gray colors are used.

Returns

CreateDarkTheme [2/2]

public static ColorScheme CreateDarkTheme(Color accentColor)
Arguments
Type Name Description
Color accentColor The accent color to use with the dark theme, to add more color to certain elements.
Summary

Create a premade dark theme color scheme. Darker gray colors are used, and a custom accent color can be provided to add some more color.

Returns

GetHighContrastScheme

public static ColorScheme GetHighContrastScheme(HighContrastOption hco)
Arguments
Type Name Description
HighContrastOption hco The high-contrast scheme option to create.
Summary

Create a color scheme with high-contrast colors, based upon one of the available options.

Returns

Properties

IsHighContrast

public bool IsHighContrast { get; set; }
Summary

Get or set whether this is a high-contrast color scheme. Some controls will differ their appearnce if this color scheme is a high contrast one.

MainColor

public Color MainColor { get; set; }
Summary

This is the main interface color, and generally the most vibrant. Despite the name, this color should not be used too commonly. With High Contrast color schemes, this will be the same as BackgroundColor.

SecondaryColor

public Color SecondaryColor { get; set; }
Summary

This is the secondary interface color, which can be used to differentiate regions of a user interface by color. Do not use this with High Contrast color schemes (use ColorScheme.IsHighContrast to check if this color scheme is a high contrast theme.

BackgroundColor

public Color BackgroundColor { get; set; }
Summary

The primary background color of a window or pane.

SelectionColor

public Color SelectionColor { get; set; }
Summary

The color used for when certain elements are being clicked on; this a darker color than the main color, and is generally used for the caption buttons of a window.

HighlightColor

public Color HighlightColor { get; set; }
Summary

The color used for when certain elements have focus or have the mouse over them; this is a darker color than the main color, and is generally used for the caption buttons of a window.

BorderColor

public Color BorderColor { get; set; }
Summary

The color used for the borders of elements and windows.

SecondHighlightColor

public Color SecondHighlightColor { get; set; }
Summary

The color used for when certain elements have focus or have the mouse over them; this is a lighter color than the main color, and is generally used by many UI elements.

ThirdHighlightColor

public Color ThirdHighlightColor { get; set; }
Summary

The color used for when certain elements are being clicked on; this is a lighter color than the main color, and is generally used by many UI elements.

LightBackgroundColor

public Color LightBackgroundColor { get; set; }
Summary

The color used for the background of certain elements. This background color is lighter than the main background color.

ForegroundColor

public Color ForegroundColor { get; set; }
Summary

The main color used for foreground elements, such as text. Ideally, this color should contrast greatly against the background colors and also the main color.

ItemColor

public Color ItemColor { get; set; }
Summary

This color is not used in Solid Shine UI, and is included for backwards compatibility reasons. You can utilize this color for your own custom needs, if desired.

LightDisabledColor

public Color LightDisabledColor { get; set; }
Summary

The color to display for items that are disabled or not usable. This color is primarily used for the backgrounds of disabled elements.

DarkDisabledColor

public Color DarkDisabledColor { get; set; }
Summary

The color to display for items that are disabled or not usable. This color is primarily used for the borders and foregrounds of disabled elements.

AccentMainColor

public Color AccentMainColor { get; set; }
Summary

This is the main interface accent color, and generally the most vibrant. With High Contrast color schemes, this will be the same as AccentBackgroundColor. Accent colors can be used wherever you wish to add more contrasting color to your UI.

AccentSecondaryColor

public Color AccentSecondaryColor { get; set; }
Summary

This is the secondary interface accent color, which can be used to differentiate regions of a user interface by color. Do not use this with High Contrast color schemes (use ColorScheme.IsHighContrast to check if this color scheme is a high contrast theme. Accent colors can be used wherever you wish to add more contrasting color to your UI.

AccentBackgroundColor

public Color AccentBackgroundColor { get; set; }
Summary

The primary background accent color of a window or pane. Accent colors can be used wherever you wish to add more contrasting color to your UI.

AccentHighlightColor

public Color AccentHighlightColor { get; set; }
Summary

The accent color used for when certain elements have focus or have the mouse over them; this is a darker color than the main color, and is generally used for the caption buttons of a window. Accent colors can be used wherever you wish to add more contrasting color to your UI.

AccentSelectionColor

public Color AccentSelectionColor { get; set; }
Summary

The accent color used for when certain elements are being clicked on; this a darker color than the main color, and is generally used for the caption buttons of a window. Accent colors can be used wherever you wish to add more contrasting color to your UI.

AccentBorderColor

public Color AccentBorderColor { get; set; }
Summary

The accent color used for the borders of elements and windows. Accent colors can be used wherever you wish to add more contrasting color to your UI.

AccentSecondHighlightColor

public Color AccentSecondHighlightColor { get; set; }
Summary

The accent color used for when certain elements have focus or have the mouse over them; this is a lighter color than the main color, and is generally used by many UI elements. Accent colors can be used wherever you wish to add more contrasting color to your UI.

AccentThirdHighlightColor

public Color AccentThirdHighlightColor { get; set; }
Summary

The accent color used for when certain elements are being clicked on; this is a lighter color than the main color, and is generally used by many UI elements. Accent colors can be used wherever you wish to add more contrasting color to your UI.

AccentLightBackgroundColor

public Color AccentLightBackgroundColor { get; set; }
Summary

The accent color used for the background of certain elements. This background color is lighter than the main background color. Accent colors can be used wherever you wish to add more contrasting color to your UI.

WindowTitleBarColor

public Color WindowTitleBarColor { get; set; }
Summary

This color is used for the title bar of windows, while they are active (as in, in the foreground and with focus).

WindowTitleBarTextColor

public Color WindowTitleBarTextColor { get; set; }
Summary

This color is used for the text in the title bar of windows, as well as for the caption buttons' icons.

WindowInactiveColor

public Color WindowInactiveColor { get; set; }
Summary

This color is used for the titlebar of windows, while they are inactive (as in, does not have focus).

MenusUseAccent

public bool MenusUseAccent { get; set; }
Summary

Determine if menus should use some accent colors while highlighting items.

Generated with ModularDoc

Clone this wiki locally