Struct ColorScheme

pub struct ColorScheme { /* private fields */ }

colorscheme of the menu

combination of FontStyle

Implementations

impl ColorScheme

pub fn new() -> Self

pub fn set_title_style(&mut self, style: FontStyle) -> &mut Self

set the style of the title

Examples found in repository

examples/complex.rs (lines 26-31)

fn main() {
    let mut menu = Menu::new().unwrap_or_else(|e| {
        quit_now!("Error: {}", e);
    });

    // build item list
    let mut item_list = Vec::new();
    for i in 1..=100 {
        item_list.push(Item::new(format!("{}th item", i).as_str(), i));
    }

    // build colorscheme, you can skip this step to use the default colorscheme
    // NOTE: sometimes your terminal might not support all the colors, so you may need to adjust
    // the colorscheme
    let mut colorscheme = termenu::ColorScheme::default();
    colorscheme
        .set_title_style(
            FontStyle::default()
                .set_shape(FontShape::Bold | FontShape::Underline)
                .set_fg_color(colored::Color::Green)
                .build(),
        )
        .set_query_style(FontStyle::default().set_shape(FontShape::Italic).build())
        .set_chosen_ln_style(
            FontStyle::default()
                .set_shape(FontShape::Underline)
                .set_fg_color(colored::Color::Black)
                .set_bg_color_256((215, 255, 0))
                .build(),
        )
        .set_more_tag_style(
            FontStyle::default()
                .set_fg_color(colored::Color::Magenta)
                .build(),
        );

    // run
    let selection = menu
        .set_title("test selection:")
        .show_end_tag(true)
        .set_max_height(0.3)
        .set_colorscheme(colorscheme)
        .add_list(item_list)
        .select() // this is the menu entry
        .unwrap_or_else(|e| {
            quit_now!("Error: {}", e);
        });

    // handle selection
    if let Some(selection) = selection {
        println!("You selected: {}", selection);
    } else {
        println!("You didn't select anything");
    }
}

pub fn set_query_style(&mut self, style: FontStyle) -> &mut Self

set the style of the query, which is the input of the user in query mode

Examples found in repository

examples/complex.rs (line 32)

fn main() {
    let mut menu = Menu::new().unwrap_or_else(|e| {
        quit_now!("Error: {}", e);
    });

    // build item list
    let mut item_list = Vec::new();
    for i in 1..=100 {
        item_list.push(Item::new(format!("{}th item", i).as_str(), i));
    }

    // build colorscheme, you can skip this step to use the default colorscheme
    // NOTE: sometimes your terminal might not support all the colors, so you may need to adjust
    // the colorscheme
    let mut colorscheme = termenu::ColorScheme::default();
    colorscheme
        .set_title_style(
            FontStyle::default()
                .set_shape(FontShape::Bold | FontShape::Underline)
                .set_fg_color(colored::Color::Green)
                .build(),
        )
        .set_query_style(FontStyle::default().set_shape(FontShape::Italic).build())
        .set_chosen_ln_style(
            FontStyle::default()
                .set_shape(FontShape::Underline)
                .set_fg_color(colored::Color::Black)
                .set_bg_color_256((215, 255, 0))
                .build(),
        )
        .set_more_tag_style(
            FontStyle::default()
                .set_fg_color(colored::Color::Magenta)
                .build(),
        );

    // run
    let selection = menu
        .set_title("test selection:")
        .show_end_tag(true)
        .set_max_height(0.3)
        .set_colorscheme(colorscheme)
        .add_list(item_list)
        .select() // this is the menu entry
        .unwrap_or_else(|e| {
            quit_now!("Error: {}", e);
        });

    // handle selection
    if let Some(selection) = selection {
        println!("You selected: {}", selection);
    } else {
        println!("You didn't select anything");
    }
}

pub fn set_items_style(&mut self, style: FontStyle) -> &mut Self

set the style of the items, which is the list of items which are displayed in the menu and not chosen yet

pub fn set_chosen_ln_style(&mut self, style: FontStyle) -> &mut Self

set the style of the chosen line, which is the line that the cursor is pointing to

Examples found in repository

examples/complex.rs (lines 33-39)

fn main() {
    let mut menu = Menu::new().unwrap_or_else(|e| {
        quit_now!("Error: {}", e);
    });

    // build item list
    let mut item_list = Vec::new();
    for i in 1..=100 {
        item_list.push(Item::new(format!("{}th item", i).as_str(), i));
    }

    // build colorscheme, you can skip this step to use the default colorscheme
    // NOTE: sometimes your terminal might not support all the colors, so you may need to adjust
    // the colorscheme
    let mut colorscheme = termenu::ColorScheme::default();
    colorscheme
        .set_title_style(
            FontStyle::default()
                .set_shape(FontShape::Bold | FontShape::Underline)
                .set_fg_color(colored::Color::Green)
                .build(),
        )
        .set_query_style(FontStyle::default().set_shape(FontShape::Italic).build())
        .set_chosen_ln_style(
            FontStyle::default()
                .set_shape(FontShape::Underline)
                .set_fg_color(colored::Color::Black)
                .set_bg_color_256((215, 255, 0))
                .build(),
        )
        .set_more_tag_style(
            FontStyle::default()
                .set_fg_color(colored::Color::Magenta)
                .build(),
        );

    // run
    let selection = menu
        .set_title("test selection:")
        .show_end_tag(true)
        .set_max_height(0.3)
        .set_colorscheme(colorscheme)
        .add_list(item_list)
        .select() // this is the menu entry
        .unwrap_or_else(|e| {
            quit_now!("Error: {}", e);
        });

    // handle selection
    if let Some(selection) = selection {
        println!("You selected: {}", selection);
    } else {
        println!("You didn't select anything");
    }
}

pub fn set_matched_style(&mut self, style: FontStyle) -> &mut Self

set the style of the matched part of the items in query mode

pub fn set_more_tag_style(&mut self, style: FontStyle) -> &mut Self

set the style of the ‘—more—’ tag, which is displayed at the bottom of the menu when there are more items than the screen can display

Examples found in repository

examples/complex.rs (lines 40-44)

fn main() {
    let mut menu = Menu::new().unwrap_or_else(|e| {
        quit_now!("Error: {}", e);
    });

    // build item list
    let mut item_list = Vec::new();
    for i in 1..=100 {
        item_list.push(Item::new(format!("{}th item", i).as_str(), i));
    }

    // build colorscheme, you can skip this step to use the default colorscheme
    // NOTE: sometimes your terminal might not support all the colors, so you may need to adjust
    // the colorscheme
    let mut colorscheme = termenu::ColorScheme::default();
    colorscheme
        .set_title_style(
            FontStyle::default()
                .set_shape(FontShape::Bold | FontShape::Underline)
                .set_fg_color(colored::Color::Green)
                .build(),
        )
        .set_query_style(FontStyle::default().set_shape(FontShape::Italic).build())
        .set_chosen_ln_style(
            FontStyle::default()
                .set_shape(FontShape::Underline)
                .set_fg_color(colored::Color::Black)
                .set_bg_color_256((215, 255, 0))
                .build(),
        )
        .set_more_tag_style(
            FontStyle::default()
                .set_fg_color(colored::Color::Magenta)
                .build(),
        );

    // run
    let selection = menu
        .set_title("test selection:")
        .show_end_tag(true)
        .set_max_height(0.3)
        .set_colorscheme(colorscheme)
        .add_list(item_list)
        .select() // this is the menu entry
        .unwrap_or_else(|e| {
            quit_now!("Error: {}", e);
        });

    // handle selection
    if let Some(selection) = selection {
        println!("You selected: {}", selection);
    } else {
        println!("You didn't select anything");
    }
}

Trait Implementations

impl Clone for ColorScheme

fn clone(&self) -> ColorScheme

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ColorScheme

fn default() -> Self

Returns the “default value” for a type.

impl Copy for ColorScheme