Struct OverlayMargin 

pub struct OverlayMargin {
    pub top: u16,
    pub right: u16,
    pub bottom: u16,
    pub left: u16,
}

Insets that keep an overlay away from viewport edges.

Fields

top: u16

Inset from the top edge.

right: u16

Inset from the right edge.

bottom: u16

Inset from the bottom edge.

left: u16

Inset from the left edge.

Implementations

impl OverlayMargin

pub const fn uniform(n: u16) -> Self

Creates equal insets on all four sides.

Examples found in repository

examples/gallery/overlay.rs (line 74)

pub(crate) fn show_help(ui: &mut Ui) -> OverlayId {
	ui.show_overlay(
		dom! {
			<box border=round title="Help">
				<col>
					<text>{"Ctrl+K  switch model"}</text>
					<text>{"Ctrl+G  toggle this help"}</text>
					<text>{"Esc     close top layer"}</text>
					<text>{"Ctrl+C  quit"}</text>
				</col>
			</box>
		},
		OverlayOptions::default()
			.anchor(OverlayAnchor::BottomRight)
			.width(Dim::Cells(30))
			.margin(OverlayMargin::uniform(1)),
	)
}

Trait Implementations

impl Clone for OverlayMargin

fn clone(&self) -> OverlayMargin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OverlayMargin

impl Debug for OverlayMargin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OverlayMargin

fn default() -> OverlayMargin

Returns the “default value” for a type.

impl Eq for OverlayMargin

impl PartialEq for OverlayMargin

fn eq(&self, other: &OverlayMargin) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for OverlayMargin