Struct Button 

pub struct Button { /* private fields */ }

Button shows a text and executes a callback when pressing Enter (while focused) Focus highlights the inner text

Design (optional Border):

┌──────┐
│Button│
└──────┘

Implementations

impl Button

pub fn default_callback(_: &mut Self)

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

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

Sets the callback, which is called when pressing Enter

pub fn set_key_handler(&mut self, f: ButtonKeyHandler)

pub fn set_text_alignment(&mut self, alignment: HorizontalAlignment)

Sets the alignment for the inner text

pub fn get_text(&self) -> &str

Returns the internal text

pub fn set_text(&mut self, text: &str)

Sets the internal shown text

Examples found in repository

examples/stackpanel.rs (line 58)

	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 execute(&mut self)

Executes the callback

Trait Implementations

impl Default for Button

fn default() -> Self

Returns the “default value” for a type.

impl HasWindowUID for Button

fn uid(&self) -> WindowUID

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

impl Widget for Button

fn set_visibility(&mut self, visibility: bool)

fn set_width(&mut self, width: Size)

fn set_height(&mut self, _: Size)

fn set_margin(&mut self, margin: Thickness)

fn set_border(&mut self, border: BorderStyle)

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, _: SizeConstraint)

impl WidgetColors for Button

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 Window for Button

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 WindowLayout for Button

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