Struct Combobox 

pub struct Combobox<T: PartialEq + 'static> { /* private fields */ }

Combobox contains a list of values of which one can be selected The selected value can be changed by using the Left and Right buttons Focus highlights the Combobox’s text

Design (Border is part of the component):

┌─┬─────────────┬─┐
│<│ Text [2/28] │>│
└─┴─────────────┴─┘

Implementations

impl<T: PartialEq> Combobox<T>

pub const INDICATOR_LEFT: Grapheme = ScrollViewer::ARROW_LEFT

pub const INDICATOR_RIGHT: Grapheme = ScrollViewer::ARROW_RIGHT

pub const DEFAULT_BORDER: BorderKind = BorderKind::Solid

pub fn default_callback(_: &mut Self)

pub fn default_key_handler(&mut self, event: &mut WindowEvent)

pub fn set_key_handler(&mut self, f: ComboboxKeyHandler<T>)

pub fn set_selection_changed_callback<F: Fn(&mut Self) + 'static>( &mut self, callback: F, )

Examples found in repository

examples/stackpanel.rs (lines 74-77)

	fn default() -> Self {
		let label = WindowFactory::create::<Label>();
		label
			.borrow_mut()
			.set_text("Please enter a valid number (x ∈ ℕ):");
		let button = WindowFactory::create::<Button>();
		button.borrow_mut().set_text("Press to increment:");
		button.borrow_mut().set_border(BorderKind::Solid.into());
		let mut cb: Combobox<u8> = Combobox::default();
		for v in [1, 2, 4] {
			cb.add_item(DisplayValue::new(v, format!("Increment by {}", v)));
		}
		let cb = Rc::new(RefCell::new(cb));
		let combobox = cb.clone();
		let numeric = WindowFactory::create::<Numeric>();
		numeric.borrow_mut().set_base(Radix::Hexadecimal);
		numeric.borrow_mut().set_min_range(8);
		numeric.borrow_mut().set_max_range(64);
		numeric.borrow_mut().set_focus_color(Some(Color::Cyan));
		let nc = numeric.clone();
		combobox
			.borrow_mut()
			.set_selection_changed_callback(move |cb| {
				let mut brw = nc.borrow_mut();
				brw.set_stepcount(*cb.get_value().unwrap().value())
			});

		let stackpanel = WindowFactory::create::<Stackpanel>();
		stackpanel.borrow_mut().set_border(BorderKind::Solid.into());
		stackpanel.borrow_mut().add_item(label);
		stackpanel.borrow_mut().add_item(numeric);
		stackpanel.borrow_mut().add_item(cb);

		Self {
			uid: WindowUID::new(),
			stackpanel,
			running: true,
		}
	}

pub fn get_value(&self) -> Option<&DisplayValue<T>>

Examples found in repository

examples/stackpanel.rs (line 76)

	fn default() -> Self {
		let label = WindowFactory::create::<Label>();
		label
			.borrow_mut()
			.set_text("Please enter a valid number (x ∈ ℕ):");
		let button = WindowFactory::create::<Button>();
		button.borrow_mut().set_text("Press to increment:");
		button.borrow_mut().set_border(BorderKind::Solid.into());
		let mut cb: Combobox<u8> = Combobox::default();
		for v in [1, 2, 4] {
			cb.add_item(DisplayValue::new(v, format!("Increment by {}", v)));
		}
		let cb = Rc::new(RefCell::new(cb));
		let combobox = cb.clone();
		let numeric = WindowFactory::create::<Numeric>();
		numeric.borrow_mut().set_base(Radix::Hexadecimal);
		numeric.borrow_mut().set_min_range(8);
		numeric.borrow_mut().set_max_range(64);
		numeric.borrow_mut().set_focus_color(Some(Color::Cyan));
		let nc = numeric.clone();
		combobox
			.borrow_mut()
			.set_selection_changed_callback(move |cb| {
				let mut brw = nc.borrow_mut();
				brw.set_stepcount(*cb.get_value().unwrap().value())
			});

		let stackpanel = WindowFactory::create::<Stackpanel>();
		stackpanel.borrow_mut().set_border(BorderKind::Solid.into());
		stackpanel.borrow_mut().add_item(label);
		stackpanel.borrow_mut().add_item(numeric);
		stackpanel.borrow_mut().add_item(cb);

		Self {
			uid: WindowUID::new(),
			stackpanel,
			running: true,
		}
	}

pub fn set_border_fg(&mut self, color: Option<Color>)

pub fn set_border_bg(&mut self, color: Option<Color>)

pub fn select_next(&mut self)

Selects the next possible element

pub fn select_previous(&mut self)

Selects the previous possible element

Trait Implementations

impl<T: PartialEq> Default for Combobox<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: PartialEq + 'static> HasWindowUID for Combobox<T>

fn uid(&self) -> WindowUID

Must be static and unique for each object implementing Window. Generate once per instance using WindowUID::new.

impl<T: PartialEq> ItemCollection<DisplayValue<T>> for Combobox<T>

type Index = usize

Type used to index the underlying collection

fn add_item(&mut self, item: DisplayValue<T>)

Adds an item to the underlying collection

fn remove_item(&mut self, item: &DisplayValue<T>)

Removes an item from the underlying collection

fn remove_at(&mut self, index: Self::Index) -> DisplayValue<T>

Removes an item at the given index from the underlying collection Might panic if index is invalid

fn get_item(&mut self, index: Self::Index) -> Option<&DisplayValue<T>>

Returns an item from the collection by its index

fn clear_items(&mut self)

Clears all items in the underlying collection

fn items(&self) -> Self::Index

Returns the number of items in the underlying collection

impl<T: PartialEq> Widget for Combobox<T>

fn set_border(&mut self, border: BorderStyle)

This is ignored

fn set_visibility(&mut self, visibility: bool)

fn set_width(&mut self, width: Size)

fn set_height(&mut self, height: Size)

fn set_margin(&mut self, margin: Thickness)

fn set_alignment( &mut self, horizontal: HorizontalAlignment, vertical: VerticalAlignment, )

fn set_enabled_state(&mut self, is_enabled: bool)

Changing the IsEnabled state usually changes the highlight color

fn set_width_constraint(&mut self, width: SizeConstraint)

fn set_height_constraint(&mut self, height: SizeConstraint)

impl<T: PartialEq> WidgetColors for Combobox<T>

fn set_disabled_color(&mut self, color: Option<Color>)

fn set_base_fg_color(&mut self, color: Option<Color>)

fn set_base_bg_color(&mut self, color: Option<Color>)

impl<T: PartialEq> Window for Combobox<T>

fn render(&self, canvas: &mut Canvas)

Allows self to draw into its own Canvas The canvas size depends on other properties set and the terminal size itself It is guarenteed that the size of the Canvas is atleast 1x1

fn handle_event(&mut self, event: &mut WindowEvent)

The events are forwarded from crossterm with the only exception of Resize which will have the same dimensions as the resulting canvas If a event’s handled attributed is set to true it will stop bubbling otherwise it will keep bubbling until another Window marks it as handled Except for:

fn is_enabled(&self) -> bool

Is self enabled? Indicated whether or not to handle input and if its focusable When false, Window is still eligible to receive events

fn children(&mut self, builder: SubWindowBuilder) -> SubWindows

Returns all children windows (and layouting Rects) Note: When changing the children make sure to also adjust the focus

fn focus(&self) -> Option<WindowRef>

Which child of the window has focus Is there is None, then ´self´ has focus

impl<T: PartialEq> WindowLayout for Combobox<T>

fn desired_size(&self, available_size: TPoint) -> TPoint

Parents call this to get the desired size of the child This must not exceed available_size on any axis When the result’s product is equal to 0, this window wont be drawn

fn border(&self) -> BorderStyle

fn alignment(&self) -> (HorizontalAlignment, VerticalAlignment)

Aligns self within its parent Window

fn is_visible(&self) -> bool

fn margin(&self) -> Thickness

fn desired_size_pre_hook(&mut self, available_size: TPoint)

This is similar to desired_size but will not return anything and can mutably change self This is executed before WindowLayout::desired_size Only implement if actually necessary