Struct libnotcurses_sys::NcPlaneOptionsBuilder

pub struct NcPlaneOptionsBuilder { /* private fields */ }

Builder object for NcPlaneOptions.

Can be constructed by calling NcPlaneOptions::builder().

By default it has the Marginalized flag already set, alongside (0, 0) margins, so that it automatically fills the parent plane.

Implementations

impl NcPlaneOptionsBuilder

Constructors

pub fn new() -> Self

New NcPlaneOptionsBuilder with the Marginalized flag set.

pub fn from_options(options: &NcPlaneOptions) -> Self

New builder from pre-existing options.

pub fn build(self) -> NcPlaneOptions

Finishes the building and returns NcPlaneOptions.

impl NcPlaneOptionsBuilder

Methods (chainable)

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

Sets the vertical placement relative to parent plane.

Default: 0.

Effect: Sets the y coordinate and unsets the VerAligned flag.

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

Sets the horizontal placement relative to parent plane.

Default: 0.

Effect: Sets the x coordinate and unsets the HorAligned flag.

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

Sets the vertical & horizontal placement relative to parent plane.

Effect: Sets the x & y coordinates and unsets the VERALIGNED and HORALIGNED flags.

Default: (0, 0).

pub fn valign(self, v: impl Into<NcAlign>) -> Self

Sets the vertical alignment.

Default: NcAlign::Top.

Effect: Sets the v alignment and the VerAligned flag.

pub fn halign(self, h: impl Into<NcAlign>) -> Self

Sets the horizontal alignment.

Default: NcAlign::Left.

Effect: Sets the h alignment and the HorAligned flag.

pub fn align(self, v: impl Into<NcAlign>, h: impl Into<NcAlign>) -> Self

Sets the vertical & horizontal alignment.

Default: (NcAlign::Top, NcAlign::Left).

Effect: Sets the v & h alignments and the VerAligned & HorAligned flags.

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

Sets the number of rows for the plane.

Must be >0 when not using margins.

Default: 0.

Effect: sets the rows field and unsets the Marginalized flag.

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

Sets the number of columns for the plane.

Must be >0 when not using margins.

Default: 0.

Effect: sets the cols field and unsets the Marginalized flag.

pub fn rows_cols(self, rows: u32, cols: u32) -> Self

Sets the number of rows & columns for the plane.

Must be >0 when not using margins.

Default: (0, 0).

Effect: sets the rows & cols fields and unsets the Marginalized flag.

pub fn margins(self, bottom: u32, right: u32) -> Self

Sets the bottom & right margins.

Default: (0, 0).

Effect: sets the margin_b & margin_r fields and the Marginalized flag.

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)sets the Fixed flag.

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

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

Setting this flag is equivalent to immediately calling set_scrolling(true) following NcPlane creation.

Default: false.

Effect: (un)sets the VScroll flag.

See also: AutoGrow.

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

If true, the plane will grow automatically.

Default: false.

Effect: (un)sets the AutoGrow flag.

Note that just setting AutoGrow makes the NcPlane grow to the right, and setting AutoGrow + VScroll makes the NcPlane grow down.

pub fn resizecb(self, callback: Option<NcResizeCb>) -> Self

(Un)Sets the resize callback.

Default: None.

impl NcPlaneOptionsBuilder

Methods (setable)

pub fn set_y(&mut self, y: i32)

Sets the vertical placement relative to parent plane.

Default: 0.

Effect: Sets the y coordinate and unsets the VerAligned flag.

pub fn set_x(&mut self, x: i32)

Sets the horizontal placement relative to parent plane.

Default: 0.

Effect: Sets the x coordinate and unsets the HorAligned flag.

pub fn set_yx(&mut self, y: i32, x: i32)

Sets the vertical & horizontal placement relative to parent plane.

Effect: Sets the x & y coordinates and unsets the VERALIGNED and HORALIGNED flags.

Default: (0, 0).

pub fn set_valign(&mut self, v: impl Into<NcAlign>)

Sets the vertical alignment.

Default: NcAlign::Top.

Effect: Sets the y alignment and the VerAligned flag.

pub fn set_halign(&mut self, h: impl Into<NcAlign>)

Sets the horizontal alignment.

Default: NcAlign::Left.

Effect: Sets the h alignment and the HorAligned flag.

pub fn set_align(&mut self, v: impl Into<NcAlign>, h: impl Into<NcAlign>)

Sets the vertical & horizontal alignment.

Default: (NcAlign::Top, NcAlign::Left).

Effect: Sets the v & h alignments and the VerAligned & HorAligned flags.

pub fn set_rows(&mut self, rows: u32)

Sets the number of rows for the plane.

Must be >0 when not using margins.

Default: 0.

Effect: sets the rows field and unsets the Marginalized flag.

pub fn set_cols(&mut self, cols: u32)

Sets the number of columns for the plane.

Must be >0 when not using margins.

Default: 0.

Effect: sets the cols field and unsets the Marginalized flag.

pub fn set_rows_cols(&mut self, rows: u32, cols: u32)

Sets the number of rows & columns for the plane.

Must be >0 when not using margins.

Default: (0, 0).

Effect: sets the rows & cols fields and unsets the Marginalized flag.

pub fn set_margins(&mut self, bottom: u32, right: u32)

Sets the bottom & right margins.

Default: (0, 0).

Effect: sets the margin_b & margin_r fields and the Marginalized flag.

pub fn set_fixed(&mut self, fixed: bool)

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

Default: false (scrolls with the parent).

Effect: (un)sets the Fixed flag.

pub fn set_vscroll(&mut self, vscroll: bool)

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

Setting this flag is equivalent to immediately calling set_scrolling(true) following NcPlane creation.

Default: false.

Effect: (un)sets the VScroll flag.

See also: AutoGrow.

pub fn set_autogrow(&mut self, autogrow: bool)

If true, the plane will grow automatically.

Default: false.

Effect: (un)sets the AutoGrow flag.

Note that just setting AutoGrow makes the NcPlane grow to the right, and setting AutoGrow + VScroll makes the NcPlane grow down.

pub fn set_resizecb(&mut self, callback: Option<NcResizeCb>)

(Un)Sets the resize callback.

Default: None.

Trait Implementations

impl Clone for NcPlaneOptionsBuilder

fn clone(&self) -> NcPlaneOptionsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NcPlaneOptionsBuilder

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

Formats the value using the given formatter.

impl Default for NcPlaneOptionsBuilder

fn default() -> Self

New NcPlaneOptionsBuilder with the Marginalized flag set.

impl From<&NcPlaneOptionsBuilder> for NcPlaneOptions

fn from(builder: &NcPlaneOptionsBuilder) -> Self

Converts to this type from the input type.

impl From<&mut NcPlaneOptionsBuilder> for NcPlaneOptions

fn from(builder: &mut NcPlaneOptionsBuilder) -> Self

Converts to this type from the input type.

impl From<&mut ncplane_options> for NcPlaneOptionsBuilder

fn from(options: &mut NcPlaneOptions) -> Self

Converts to this type from the input type.

impl From<&ncplane_options> for NcPlaneOptionsBuilder

fn from(options: &NcPlaneOptions) -> Self

Converts to this type from the input type.

impl From<NcPlaneOptionsBuilder> for NcPlaneOptions

fn from(builder: NcPlaneOptionsBuilder) -> NcPlaneOptions

Converts to this type from the input type.

impl From<ncplane_options> for NcPlaneOptionsBuilder

fn from(options: NcPlaneOptions) -> NcPlaneOptionsBuilder

Converts to this type from the input type.