Struct Label 

pub struct Label { /* private fields */ }

Represents a single text label

Design (optional Border):

┌─────┐
│Label│
└─────┘

Implementations

impl Label

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

Sets the alignment of the inner text

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

Replaces the inner text

Examples found in repository

examples/tabview.rs (line 33)

	fn default() -> Self {
		let label = WindowFactory::create::<Label>();
		label.borrow_mut().set_text("Lorem ipsum");
		let label2 = WindowFactory::create::<Label>();
		label2.borrow_mut().set_text("Bibsum loram");
		let label3 = WindowFactory::create::<Label>();
		label3.borrow_mut().set_text("Epsum larel");
		let label4 = WindowFactory::create::<Label>();
		label4.borrow_mut().set_text("Ipsel Aarel");

		let tabview = WindowFactory::create::<TabView>();
		{
			let mut brw = tabview.borrow_mut();
			brw.enable_tab_enumeration();
			brw.set_highlight_fg_color(Some(Color::Grey));
			brw.set_highlight_bg_color(Some(Color::Blue));
			brw.add_item(Tab::new("WIP Tab Number. 1", label));
			brw.add_item(Tab::new("WIP Tab Number. 2", label2));
			brw.add_item(Tab::new("WIP Tab Number. 3", label3));
			brw.add_item(Tab::new("WIP Tab Number. 4", label4));
		}

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

examples/dockpanel.rs (line 32)

	fn default() -> Self {
		let label = WindowFactory::create::<Label>();
		label.borrow_mut().set_text("Lorem ipsum");
		let label2 = WindowFactory::create::<Label>();
		label2.borrow_mut().set_text("Bibsum loram");
		let label3 = WindowFactory::create::<Label>();
		label3.borrow_mut().set_text("Epsum larel");
		let label4 = WindowFactory::create::<Label>();
		label4.borrow_mut().set_text("Ipsel Aarel");
		let input = WindowFactory::create::<Textbox>();

		let dockpanel = WindowFactory::create::<DockPanel>();
		{
			let mut brw = dockpanel.borrow_mut();
			brw.set_child(DockAlignment::Center, Some(input));
			brw.set_child(DockAlignment::Top, Some(label));
			brw.set_child(DockAlignment::Right, Some(label2));
			brw.set_child(DockAlignment::Left, Some(label3));
			brw.set_child(DockAlignment::Bottom, Some(label4));
			brw.set_border(BorderStyle::new(BorderKind::Dashed, None, None));
			brw.set_inner_border(true);
		}

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

examples/stackpanel.rs (line 56)

	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_text(&self) -> &str

Gets the inner text

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

Trait Implementations

impl Default for Label

fn default() -> Self

Returns the “default value” for a type.

impl HasWindowUID for Label

fn uid(&self) -> WindowUID

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

impl Widget for Label

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

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_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 Label

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 Label

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 Label

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 alignment(&self) -> (HorizontalAlignment, VerticalAlignment)

Aligns self within its parent Window

fn margin(&self) -> Thickness

fn border(&self) -> BorderStyle

fn is_visible(&self) -> bool

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