Struct PlaneBuilder 

pub struct PlaneBuilder { /* private fields */ }

A Plane builder.

Implementations

impl PlaneBuilder

Constructors

pub fn new() -> Self

Returns a new default PlaneBuilder.

Size, position and margins are set to 0. The plane will be maximized to its parent size.

pub fn build(self, nc: &Notcurses) -> Result<Plane>

Returns a new standalone Plane.

pub fn build_child(self, parent: &mut Plane) -> Result<Plane>

Returns a new child Plane of the provided parent.

impl PlaneBuilder

Methods (chainable)

pub fn y(self, y: i32) -> Self

Sets the vertical position relative to the parent plane.

Default: 0.

Effect: Sets the y coordinate and unsets vertical alignment.

pub fn x(self, x: i32) -> Self

Sets the horizontal position relative to the parent plane.

Default: 0.

Effect: Sets the x coordinate and unsets vertical alignment.

pub fn position(self, position: impl Into<Position>) -> Self

Sets the position relative to parent plane.

Default: 0, 0.

Effect: Sets both x & y coordinates and unsets both horizontal and vertical alignment.

pub fn valign(self, vertical: Align) -> Self

Sets the vertical alignment.

Default: Align::Top.

Effect: Sets v alignment.

pub fn halign(self, horizontal: Align) -> Self

Sets the horizontal alignment.

Default: Align::Left.

Effect: Sets h alignment.

pub fn align(self, vertical: Align, horizontal: Align) -> Self

Sets the vertical & horizontal placement relative to parent plane.

Default: 0, 0.

Effect: Sets both horizontal and vertical alignment.

pub fn height(self, height: u32) -> Self

Sets the height of the plane (rows).

Default: 0.

Effect: Sets the height of the plane and unmaximizes it.

pub fn width(self, width: u32) -> Self

Sets the width for the plane (columns).

Default: 0.

Effect: Sets the width of the plane and unmaximizes it.

pub fn size(self, size: impl Into<Size>) -> Self

Sets the size of the plane (rows, columns).

Default: 0.

Effect: Sets the height and width of the plane and unmaximizes it.

pub fn maximize(self, right_bottom: impl Into<Size>) -> Self

Maximizes the plane, with optional right & bottom margins.

Default: (0, 0).

Effect: maximizes the plane relative to the parent plane, minus the provided margins.

See also: sys::NcPlaneFlag::Marginalized.

pub fn fixed(self, fixed: bool) -> Self

If true, the plane will not scroll with the parent.

Default: false (scrolls with the parent).

Effect: (un)fixes the plane.

See also: sys::NcPlaneFlag::Fixed.

pub fn scroll(self, scroll: bool) -> Self

If true, the plane will scroll vertically to accommodate output.

This is equivalent to immediately calling set_scrolling(true) following Plane creation.

Default: false.

Effect: (un)sets vertical scrolling.

pub fn autogrow(self, autogrow: bool) -> Self

If true, the plane will grow automatically.

Default: false.

Effect: (un)sets the plane to automatically grow to accomodate output.

Note that just setting autogrow makes the plane grow to the right, and setting autogrow and scroll makes the plane grow downwards.

Trait Implementations

impl Debug for PlaneBuilder

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

Formats the value using the given formatter.

impl Default for PlaneBuilder

fn default() -> PlaneBuilder

Returns the “default value” for a type.