Struct DockPanel 

pub struct DockPanel { /* private fields */ }

The center element takes most of the space, but at least 50% in width and height, depending how big the other elements are. The outer elements are technically computed within the layout first and the center is the last one. Each outer element should occupy at most 25% of the width/height - their relative size is relative to the maximum 25%. In case their size is fixed, the heuristic will choose MIN(<fixed window size>, <25% of the dockpanels size>). This control by default has no keybindings.

┌───────────────────────┐
│         Top           │
├──────┬────────┬───────┤
│ Left │ Center │ Right │
├──────┴────────┴───────┤
│        Bottom         │
└───────────────────────┘

Implementations

impl DockPanel

pub const MAX_CHILD_SIZE: Size

The maximum size of an outer (non-center) child element

pub fn new(inner_border: bool) -> Self

pub fn default_callback(_: &mut Self)

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

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

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

pub fn set_inner_border(&mut self, inner_border: bool)

Examples found in repository

examples/dockpanel.rs (line 50)

	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,
		}
	}

pub fn set_child(&mut self, dock: DockAlignment, child: Option<WindowRef>)

Examples found in repository

examples/dockpanel.rs (line 44)

	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,
		}
	}

pub fn set_focus(&mut self, dock: DockAlignment)

Trait Implementations

impl Default for DockPanel

fn default() -> Self

Returns the “default value” for a type.

impl HasWindowUID for DockPanel

fn uid(&self) -> WindowUID

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

impl Widget for DockPanel

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

impl WidgetColors for DockPanel

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 DockPanel

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

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

impl WindowLayout for DockPanel

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