Class

ThemeCheckOptions

ConsoleMonster.Styling

Edit on GitHub

Namespace: ConsoleMonster.Styling
Assembly: ConsoleMonster
Source: ThemeCheckOptions.cs:9
Modifiers: sealed

The known drawing conditions for a theme check. Palette colours and terminal-dependent dimming remain unknown.

Inheritance

object
ThemeCheckOptions

Usage

Explore 13 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 6

Method StylingFluent.Background
Method StylingFluent.GlyphTier
Method StylingFluent.StatusMarkers
Extension method ThemeCheckOptions.Background
Extension method ThemeCheckOptions.GlyphTier
Extension method ThemeCheckOptions.StatusMarkers

Accepted by parameters 7

Method StylingFluent.Background parameter themeCheckOptions
Method StylingFluent.GlyphTier parameter themeCheckOptions
Method StylingFluent.StatusMarkers parameter themeCheckOptions
Method ThemeCheck.Run parameter options
Extension method ThemeCheckOptions.Background parameter themeCheckOptions
Extension method ThemeCheckOptions.GlyphTier parameter themeCheckOptions
Extension method ThemeCheckOptions.StatusMarkers parameter themeCheckOptions

Constructors

public ThemeCheckOptions() #

ThemeCheckOptions.cs:9

Inherited Methods

Properties

public Color? Background { get; set; } #

ThemeCheckOptions.cs:7

The page colour. Null uses #0c0c0c for a dark Theme or #ffffff for a light Theme; other ITheme implementations need an explicit background.

public GlyphTier? GlyphTier { get; set; } #

ThemeCheckOptions.cs:9

The renderable glyph tier; null means markers cannot be assessed. Defaults to Full.

public StatusMarkerStyle? StatusMarkers { get; set; } #

ThemeCheckOptions.cs:11

The profile's status-marker override; null uses the theme's appearance, or Symbols for another ITheme implementation.

Extension Methods

public static ThemeCheckOptions Background(ThemeCheckOptions themeCheckOptions, Color? value) #

Sets ThemeCheckOptions.Background: The page colour. Null uses #0c0c0c for a dark Theme or #ffffff for a light Theme; other ITheme implementations need an explicit background.

Parameters

themeCheckOptions ConsoleMonster.Styling.ThemeCheckOptions required: The instance.
value ConsoleMonster.Styling.Color? required: The value.

Returns

ThemeCheckOptions The same instance.

Examples

// C# initializer or property                                                   // C# fluent
new global::ConsoleMonster.Styling.ThemeCheckOptions { Background = value };    themeCheckOptions.Background(value);

public static ThemeCheckOptions GlyphTier(ThemeCheckOptions themeCheckOptions, GlyphTier? value) #

Sets ThemeCheckOptions.GlyphTier: The renderable glyph tier; null means markers cannot be assessed. Defaults to Full.

Parameters

themeCheckOptions ConsoleMonster.Styling.ThemeCheckOptions required: The instance.
value ConsoleMonster.Capabilities.GlyphTier? required: The value.

Returns

ThemeCheckOptions The same instance.

Examples

// C# initializer or property                                                  // C# fluent
new global::ConsoleMonster.Styling.ThemeCheckOptions { GlyphTier = value };    themeCheckOptions.GlyphTier(value);

public static ThemeCheckOptions StatusMarkers(ThemeCheckOptions themeCheckOptions, StatusMarkerStyle? value) #

Sets ThemeCheckOptions.StatusMarkers: The profile's status-marker override; null uses the theme's appearance, or Symbols for another ITheme implementation.

Parameters

themeCheckOptions ConsoleMonster.Styling.ThemeCheckOptions required: The instance.
value ConsoleMonster.Styling.StatusMarkerStyle? required: The value.

Returns

ThemeCheckOptions The same instance.

Examples

// C# initializer or property                                                      // C# fluent
new global::ConsoleMonster.Styling.ThemeCheckOptions { StatusMarkers = value };    themeCheckOptions.StatusMarkers(value);