Struct libnotcurses_sys::NcPlaneOptionsBuilder

pub struct NcPlaneOptionsBuilder { /* fields omitted */ }

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 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

pub fn y(self, y: NcOffset) -> 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: NcOffset) -> 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: NcOffset, x: NcOffset) -> 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, valign: NcAlign) -> Self

Sets the vertical alignment.

Default: NcAlign::Top.

Effect: Sets the y alignment and the VERALIGNED flag.

pub fn halign(self, halign: NcAlign) -> Self

Sets the horizontal alignment.

Default: NcAlign::Left.

Effect: Sets the x alignment and the HORALIGNED flag.

pub fn align(self, halign: NcAlign) -> Self

Sets the vertical & horizontal alignment.

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

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

pub fn rows(self, rows: NcDim) -> 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: NcDim) -> 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: NcDim, cols: NcDim) -> 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: NcDim, right: NcDim) -> 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.

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

Performs the conversion.

impl From<&'_ mut NcPlaneOptionsBuilder> for NcPlaneOptions

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

Performs the conversion.

impl From<&'_ mut ncplane_options> for NcPlaneOptionsBuilder

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

Performs the conversion.

impl From<&'_ ncplane_options> for NcPlaneOptionsBuilder

fn from(options: &NcPlaneOptions) -> Self

Performs the conversion.

impl From<NcPlaneOptionsBuilder> for NcPlaneOptions

fn from(builder: NcPlaneOptionsBuilder) -> NcPlaneOptions

Performs the conversion.

impl From<ncplane_options> for NcPlaneOptionsBuilder

fn from(options: NcPlaneOptions) -> NcPlaneOptionsBuilder

Performs the conversion.