Struct Frame 

pub struct Frame {
    pub above: bool,
    pub below: bool,
    pub left: bool,
    pub right: bool,
    pub style: Option<FrameStyle>,
    pub form: Option<FormId>,
    /* private fields */
}

A frame around a spawned Area

This can be configured on an Area per Area basis, or you can set a global configuration. In that case Widgets should strive to respect the style field, even if they override the other fields as necessary.

Fields

above: bool

Show a frame above

below: bool

Show a frame below

left: bool

Show a frame on the left

right: bool

Show a frame on the right

style: Option<FrameStyle>

The Frame’s style

form: Option<FormId>

Which FormId should be used for the frame

Implementations

impl Frame

pub fn sides(&self) -> impl Iterator<Item = bool>

An Iterator over the sides of the Frame

The order is: above, below, left, right

pub fn draw( &self, stdout: &mut BufWriter<File>, coords: Coords, form: Form, max: Coord, )

Draws the frame

pub fn set_text( &mut self, side: Side, text_fn: impl Fn(usize) -> Text + 'static, )

Prints a Side as Text

You can use this to, for example, set a title for your widget. This method takes in a function, which produces a Text from the length of the corresponding Side.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl PartialEq for Frame

fn eq(&self, other: &Self) -> 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 Eq for Frame