Struct cursive_core::theme::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) -> Selfwhere
    F: Into<ColorType>,
    B: Into<ColorType>,

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

Examples

use cursive::theme::ColorStyle;

// `BaseColor` implements `Into<ColorStyle>`
use cursive::theme::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::theme::PaletteColor::*;
let primary = ColorStyle::new(Primary, View);

pub fn front<F>(front: F) -> Selfwhere
    F: Into<ColorType>,

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

Examples

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

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

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

pub fn back<B>(back: B) -> Selfwhere
    B: Into<ColorType>,

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

Examples

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

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

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

pub fn invert(self) -> Self

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

Examples

use cursive::theme::BaseColor::*;
use cursive::theme::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 fn inherit_parent() -> Self

Uses ColorType::InheritParent for both front and background.

pub fn terminal_default() -> Self

Style set by terminal before entering a Cursive program.

pub fn background() -> Self

Application background, where no view is present.

pub fn shadow() -> Self

Color used by view shadows. Only background matters.

pub fn primary() -> Self

Main text with default background.

pub fn secondary() -> Self

Secondary text color, with default background.

pub fn tertiary() -> Self

Tertiary text color, with default background.

pub fn title_primary() -> Self

Title text color with default background.

pub fn title_secondary() -> Self

Alternative color for a title.

pub fn highlight() -> Self

Alternate text with highlight background.

pub fn highlight_inactive() -> Self

Highlight color for inactive views (not in focus).

pub fn merge(old: Self, new: Self) -> Self

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: FnMut(ColorType) -> ColorType>(self, f: F) -> Self

Apply a function to both the front and back colors.

pub fn zip_map<F: FnMut(ColorType, ColorType) -> ColorType>(
    self,
    other: Self,
    f: F
) -> Self

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

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 ColorStylewhere
    F: Into<ColorType>,
    B: Into<ColorType>,

fn from((front, back): (F, B)) -> Self

Converts to this type from the input type.

impl From<BaseColor> for ColorStyle

fn from(color: BaseColor) -> Self

Converts to this type from the input type.

impl From<Color> for ColorStyle

fn from(color: Color) -> Self

Converts to this type from the input type.

impl From<ColorStyle> for Style

fn from(color: ColorStyle) -> Self

Converts to this type from the input type.

impl From<ColorType> for ColorStyle

fn from(color: ColorType) -> Self

Converts to this type from the input type.

impl From<PaletteColor> for ColorStyle

fn from(color: PaletteColor) -> Self

Converts to this type from the input type.

impl Hash for ColorStyle

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

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<ColorStyle> for ColorStyle

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for ColorStyle

impl Eq for ColorStyle

impl StructuralEq for ColorStyle

impl StructuralPartialEq for ColorStyle