Enum FrameLayout 

pub enum FrameLayout<S> {
    External {
        left: Dimension<i32>,
        top: Dimension<i32>,
        width: Option<Dimension<u32>>,
        height: Option<Dimension<u32>>,
        floating: bool,
    },
    Internal {
        align: FrameAlign,
        width: Option<Dimension<u32>>,
        height: Option<Dimension<u32>>,
        dock: Option<S>,
    },
}

Alignment and position of a Frame, which may either be an external (floating) frame or an internal (docked) frame.

See MXP specification: <FRAME> and the additions documented in MUD Standards: Frames.

Variants

External

Specifies that the frame is a floating frame.

Fields

left: Dimension<i32>

The coordinate of the left side of the frame. If a negative number is used, it means the value is relative to the right side of the screen instead of the left.

top: Dimension<i32>

The coordinate of the top of the frame. If a negative value is used, it means the frame is relative to the bottom of the screen instead of the top.

width: Option<Dimension<u32>>

The width of the frame. Percentage is calculated relative to screen width.

height: Option<Dimension<u32>>

The height of the frame. Percentage is calculated relative to screen height.

floating: bool

Forces the frame to “stay on top” of the main MUD window.

Internal

Specifies that the frame is internal to another window.

Fields

align: FrameAlign

Specifies how the frame is docked with the MUD window.

width: Option<Dimension<u32>>

The width of the frame. Percentage is calculated relative to main window width.

height: Option<Dimension<u32>>

The height of the frame. Percentage is calculated relative to main window height.

dock: Option<S>

Name of the window to dock into. If omitted, defaults to the main MUD window.

Implementations

impl<S> FrameLayout<S>

pub fn map_text<T, F>(self, f: F) -> FrameLayout<T>

where F: FnOnce(S) -> T,

Applies a type transformation to all text, returning a new struct.

impl<S: AsRef<str>> FrameLayout<S>

pub fn borrow_text(&self) -> FrameLayout<&str>

Applies a type transformation to all text, returning a new struct.

Trait Implementations

impl<S: Clone> Clone for FrameLayout<S>

fn clone(&self) -> FrameLayout<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for FrameLayout<S>

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

Formats the value using the given formatter.

impl<S> Default for FrameLayout<S>

fn default() -> Self

Returns the “default value” for a type.

impl<S: PartialEq> PartialEq for FrameLayout<S>

fn eq(&self, other: &FrameLayout<S>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<S: Copy> Copy for FrameLayout<S>

impl<S: Eq> Eq for FrameLayout<S>

impl<S> StructuralPartialEq for FrameLayout<S>