Struct SalsaTheme 

pub struct SalsaTheme {
    pub name: String,
    pub cat: Category,
    pub p: Palette,
    /* private fields */
}

SalsaTheme holds any predefined styles for the UI.

The foremost usage is as a store of named Styles. It can also hold the structured styles used by rat-widget’s. Or really any value that can be produced by a closure.

It uses a flat naming scheme and doesn’t cascade upwards at all.

Fields

name: String

cat: Category

p: Palette

Implementations

impl SalsaTheme

pub fn new(name: impl Into<String>, cat: Category, p: Palette) -> Self

Create an empty theme with a given color palette.

pub fn name(&self) -> &str

Some display name.

pub fn define_style(&mut self, name: &'static str, style: Style)

Define a style as a plain Style.

pub fn define_clone( &mut self, name: &'static str, sample: impl Clone + Any + Debug + 'static, )

Define a style a struct that will be cloned for every query.

pub fn define_fn<O: Any + Debug>( &mut self, name: &'static str, create: impl Fn(&SalsaTheme) -> O + 'static, )

Define a style as a call to a constructor fn.

The constructor gets access to all previously defined styles.

pub fn define_fn0<O: Any + Debug>( &mut self, name: &'static str, create: impl Fn() -> O + 'static, )

Define a style as a call to a constructor fn.

This one takes no arguments, this is nice to set Widget::default as the style-fn.

pub fn modify<O: Any + Default + Debug + Sized + 'static>( &mut self, name: &'static str, modify: impl Fn(O, &SalsaTheme) -> O + 'static, )

Add a modification of a defined style.

This function is applied to the original style every time the style is queried.

Currently only a single modification is possible. If you set a second one it will overwrite the previous.

Panic

• When debug_assertions are enabled the modifier will panic if it gets a type other than O.
• Otherwise it will fall back to the default value of O.

pub fn style_style(&self, name: &str) -> Style

where Self: Sized,

Get one of the defined ratatui-Styles.

This is the same as the single [style] function, it just fixes the return-type to Style. This is useful if the receiver is defined as impl Into<Style>.

This may fail:

Panic

• When debug_assertions are enabled it will panic when called with an unknown style name, or if the downcast to the out type fails.
• Otherwise, it will return the default value of the out type.

pub fn style<O: Default + Sized + 'static>(&self, name: &str) -> O

where Self: Sized,

Get any of the defined styles.

It downcasts the stored value to the required out type.

This may fail:

Panic

• When debug_assertions are enabled it will panic when called with an unknown style name, or if the downcast to the out type fails.
• Otherwise, it will return the default value of the out type.

Trait Implementations

impl Debug for SalsaTheme

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

Formats the value using the given formatter.

impl Default for SalsaTheme

fn default() -> Self

Returns the “default value” for a type.