Struct libnotcurses_sys::NcPlaneOptionsBuilder

source · [−]

pub struct NcPlaneOptionsBuilder { /* private fields */ }

Expand description

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

source

impl NcPlaneOptionsBuilder

Constructors

source

pub fn new() -> Self

New NcPlaneOptionsBuilder with the Marginalized flag set.

source

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

New builder from pre-existing options.

source

pub fn build(self) -> NcPlaneOptions

Finishes the building and returns NcPlaneOptions.

source

impl NcPlaneOptionsBuilder

Methods (chainable)

source

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.

source

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.

source

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

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

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.

source

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

(Un)Sets the resize callback.

Default: None.

source

impl NcPlaneOptionsBuilder

Methods (setable)

source

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.

source

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.

source

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

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

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.

source

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

(Un)Sets the resize callback.

Default: None.

Trait Implementations

source

impl Clone for NcPlaneOptionsBuilder

source

fn clone(&self) -> NcPlaneOptionsBuilder

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for NcPlaneOptionsBuilder

source

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

Formats the value using the given formatter. Read more

source

impl Default for NcPlaneOptionsBuilder

source

fn default() -> Self

New NcPlaneOptionsBuilder with the Marginalized flag set.

source

impl From<&NcPlaneOptionsBuilder> for NcPlaneOptions

source

fn from(builder: &NcPlaneOptionsBuilder) -> Self

Converts to this type from the input type.

source

impl From<&mut NcPlaneOptionsBuilder> for NcPlaneOptions

source

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

Converts to this type from the input type.

source

impl From<&mut ncplane_options> for NcPlaneOptionsBuilder

source

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

Converts to this type from the input type.

source

impl From<&ncplane_options> for NcPlaneOptionsBuilder

source

fn from(options: &NcPlaneOptions) -> Self

Converts to this type from the input type.

source

impl From<NcPlaneOptionsBuilder> for NcPlaneOptions

source

fn from(builder: NcPlaneOptionsBuilder) -> NcPlaneOptions

Converts to this type from the input type.

source

impl From<ncplane_options> for NcPlaneOptionsBuilder

source

fn from(options: NcPlaneOptions) -> NcPlaneOptionsBuilder

Converts to this type from the input type.

Auto Trait Implementations

impl RefUnwindSafe for NcPlaneOptionsBuilder

impl Send for NcPlaneOptionsBuilder

impl Sync for NcPlaneOptionsBuilder

impl Unpin for NcPlaneOptionsBuilder

impl UnwindSafe for NcPlaneOptionsBuilder

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct libnotcurses_sys::NcPlaneOptionsBuilder

Implementations

impl NcPlaneOptionsBuilder

pub fn new() -> Self

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

pub fn build(self) -> NcPlaneOptions

impl NcPlaneOptionsBuilder

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl NcPlaneOptionsBuilder

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for NcPlaneOptionsBuilder

fn clone(&self) -> NcPlaneOptionsBuilder

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

impl Debug for NcPlaneOptionsBuilder

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

impl Default for NcPlaneOptionsBuilder

fn default() -> Self

impl From<&NcPlaneOptionsBuilder> for NcPlaneOptions

fn from(builder: &NcPlaneOptionsBuilder) -> Self

impl From<&mut NcPlaneOptionsBuilder> for NcPlaneOptions

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

impl From<&mut ncplane_options> for NcPlaneOptionsBuilder

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

impl From<&ncplane_options> for NcPlaneOptionsBuilder

fn from(options: &NcPlaneOptions) -> Self

impl From<NcPlaneOptionsBuilder> for NcPlaneOptions

fn from(builder: NcPlaneOptionsBuilder) -> NcPlaneOptions

impl From<ncplane_options> for NcPlaneOptionsBuilder

fn from(options: NcPlaneOptions) -> NcPlaneOptionsBuilder

Auto Trait Implementations

impl RefUnwindSafe for NcPlaneOptionsBuilder

impl Send for NcPlaneOptionsBuilder

impl Sync for NcPlaneOptionsBuilder

impl Unpin for NcPlaneOptionsBuilder

impl UnwindSafe for NcPlaneOptionsBuilder

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,