Struct ColorStyle

pub struct ColorStyle {
    pub front: ColorType,
    pub back: ColorType,
}

Possible color style for a cell.

Represents a color pair role to use when printing something.

The current theme will assign each role a foreground and background color.

The Default value is to inherit the parent’s colors.

Fields

front: ColorType

Color used for the foreground (the text itself).

back: ColorType

Color used for the background.

Implementations

impl ColorStyle

pub fn new<F, B>(front: F, back: B) -> ColorStyle

where F: Into<ColorType>, B: Into<ColorType>,

Creates a new color style, using the given values for front and back.

Examples

use cursive::style::ColorStyle;

// `BaseColor` implements `Into<ColorStyle>`
use cursive::style::BaseColor::*;
let red_on_black = ColorStyle::new(Red, Black);

// So does `Color`.
let red_on_black = ColorStyle::new(Red.light(), Black.dark());

// Or `PaletteColor`.
use cursive::style::PaletteColor::*;
let primary = ColorStyle::new(Primary, View);

pub fn front<F>(front: F) -> ColorStyle

where F: Into<ColorType>,

Uses the given color as front, inherits the parent background color.

Examples

use cursive::style::{BaseColor::*, ColorStyle, ColorType};

let color = ColorStyle::front(Red.dark());

assert_eq!(color, ColorStyle::new(Red.dark(), ColorType::InheritParent));

pub fn back<B>(back: B) -> ColorStyle

where B: Into<ColorType>,

Uses the given color as background, inherits the parent front color.

Examples

use cursive::style::{BaseColor::*, ColorStyle, ColorType};

let color = ColorStyle::back(Black.dark());

assert_eq!(
    color,
    ColorStyle::new(ColorType::InheritParent, Black.dark())
);

pub const fn invert(self) -> ColorStyle

Returns an inverted color style, with the front and back colors swapped.

Examples

use cursive::style::BaseColor::*;
use cursive::style::ColorStyle;

let red_on_black = ColorStyle::new(Red.dark(), Black.dark());
let black_on_red = red_on_black.invert();

assert_eq!(black_on_red, ColorStyle::new(Black.dark(), Red.dark()));

pub const fn inherit_parent() -> ColorStyle

Uses ColorType::InheritParent for both front and background.

pub const fn terminal_default() -> ColorStyle

Style set by terminal before entering a Cursive program.

pub const fn background() -> ColorStyle

Application background, where no view is present.

pub const fn shadow() -> ColorStyle

Color used by view shadows. Only background matters.

pub const fn view() -> ColorStyle

Color used by views.

Primary foreground, View background.

pub const fn primary() -> ColorStyle

Main text with default background.

pub const fn secondary() -> ColorStyle

Secondary text color, with default background.

pub const fn tertiary() -> ColorStyle

Tertiary text color, with default background.

pub const fn title_primary() -> ColorStyle

Title text color with default background.

pub const fn title_secondary() -> ColorStyle

Alternative color for a title.

pub const fn highlight() -> ColorStyle

Alternate text with highlight background.

pub const fn highlight_inactive() -> ColorStyle

Highlight color for inactive views (not in focus).

pub const fn merge(old: ColorStyle, new: ColorStyle) -> ColorStyle

Merge the color type new over the color type old.

This merges the front and back color types of a and b.

pub fn resolve(&self, palette: &Palette, previous: ColorPair) -> ColorPair

Return the color pair that this style represents.

pub fn map<F>(self, f: F) -> ColorStyle

where F: FnMut(ColorType) -> ColorType,

Apply a function to both the front and back colors.

pub fn zip_map<F>(self, other: ColorStyle, f: F) -> ColorStyle

where F: FnMut(ColorType, ColorType) -> ColorType,

Apply a function to each pair of front/back color.

Trait Implementations

impl Clone for ColorStyle

fn clone(&self) -> ColorStyle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ColorStyle

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ColorStyle

fn default() -> ColorStyle

Returns the “default value” for a type.

impl<F, B> From<(F, B)> for ColorStyle

where F: Into<ColorType>, B: Into<ColorType>,

fn from(_: (F, B)) -> ColorStyle

Converts to this type from the input type.

impl From<BaseColor> for ColorStyle

fn from(color: BaseColor) -> ColorStyle

Converts to this type from the input type.

impl From<Color> for ColorStyle

fn from(color: Color) -> ColorStyle

Converts to this type from the input type.

impl From<ColorPair> for ColorStyle

fn from(color: ColorPair) -> ColorStyle

Converts to this type from the input type.

impl From<ColorStyle> for Style

fn from(color: ColorStyle) -> Style

Converts to this type from the input type.

impl From<ColorStyle> for StyleType

fn from(color: ColorStyle) -> StyleType

Converts to this type from the input type.

impl From<ColorType> for ColorStyle

fn from(color: ColorType) -> ColorStyle

Converts to this type from the input type.

impl From<PaletteColor> for ColorStyle

fn from(color: PaletteColor) -> ColorStyle

Converts to this type from the input type.

impl Hash for ColorStyle

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ColorStyle

fn eq(&self, other: &ColorStyle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resolvable for ColorStyle

fn from_config(config: &Value, context: &Context) -> Result<ColorStyle, Error>

Build from a config (a JSON value).

fn from_any(any: Box<dyn Any>) -> Option<Self>

where Self: Sized + Any,

Build from an Any variable.

impl Copy for ColorStyle

impl Eq for ColorStyle

impl StructuralPartialEq for ColorStyle