Type Definition libnotcurses_sys::NcPlaneOptions[−][src]

pub type NcPlaneOptions = ncplane_options;

Expand description

Options struct for NcPlane.

It is recommended to construct it via NcPlaneOptionsBuilder by calling NcPlaneOptions::builder().

Fields

y: vertical placement relative to parent plane.
x: horizontal placement relative to parent plane.
rows: vertical length in rows.
cols: horizontal length in columns.
userptr: optional user curry.
name: optional string identifier for debugging.
resizecb: callback when parent is resized.
flags: bitmask of options: HORALIGNED, VERALIGNED, FIXED, MARGINALIZED, AUTOGROW, VSCROLL.
margin_b: bottom margin (requires the MARGINALIZED flag).
margin_r: right margin (requires the MARGINALIZED).

Implementations

impl NcPlaneOptions

Constants

pub const HORALIGNED: u64

Horizontal alignment relative to the parent plane. Use NcAlign for ‘x’.

pub const VERALIGNED: u64

Vertical alignment relative to the parent plane. Use NcAlign for ‘y’.

pub const MARGINALIZED: u64

Maximize relative to the parent plane, modulo the provided margins.

The margins are best-effort; the plane will always be at least 1 column by 1 row. If the margins can be effected, the plane will be sized to all remaining space. ‘y’ and ‘x’ are overloaded as the top and left margins when this flag is used. ‘rows’ and ‘cols’ must be 0 when this flag is used. This flag is exclusive with both of the alignment flags.

pub const FIXED: u64

Do not scroll alongside its parent.

If this plane is bound to a scrolling plane, it ought not scroll along with the parent (it will still move with the parent, maintaining its relative position, if the parent is moved to a new location).

pub const AUTOGROW: u64

Enables automatic growth of the plane to accommodate output.

Creating a plane with this flag is equivalent to immediately calling NcPlane::set_autogrow(true) following plane creation.

pub const VSCROLL: u64

Enables vertical scrolling of the plane to accommodate output.

Creating a plane with this flag is equivalent to immediately calling NcPlane::set_scrolling(true) following plane creation.

impl NcPlaneOptions

Constructors

pub fn new(y: NcOffset, x: NcOffset, rows: NcDim, cols: NcDim) -> Self

New NcPlaneOptions using the horizontal x.

pub fn builder() -> NcPlaneOptionsBuilder

Returns a default builder object for NcPlaneOptions.

pub fn to_builder(&self) -> NcPlaneOptionsBuilder

Returns a builder object for NcPlaneOptions from the current options.

pub fn new_aligned(
    y: NcOffset,
    align: NcAlign,
    rows: NcDim,
    cols: NcDim
) -> Self

New NcPlaneOptions with horizontal alignment.

pub fn with_flags(
    y: NcOffset,
    x: NcOffset,
    rows: NcDim,
    cols: NcDim,
    resizecb: Option<NcResizeCb>,
    flags: u64,
    margin_b: NcDim,
    margin_r: NcDim
) -> Self

New NcPlaneOptions, with flags.

pub fn with_flags_aligned(
    y: NcOffset,
    align: NcAlign,
    rows: NcDim,
    cols: NcDim,
    resizecb: Option<NcResizeCb>,
    flags: u64
) -> Self

New NcPlaneOptions, with flags and horizontal alignment.

Note: Already includes the NcPlaneOptions::HORALIGNED flag.

impl NcPlaneOptions

Methods

pub const fn is_veraligned(&self) -> bool

Returns true if it has the VERALIGNED flag set.

pub const fn is_horaligned(&self) -> bool

Returns true if it has the HORALIGNED flag set.

pub const fn is_marginalized(&self) -> bool

Returns true if it has the MARGINALIZED flag set.

pub const fn is_fixed(&self) -> bool

Returns true if it has the FIXED flag set.

pub const fn is_autogrow(&self) -> bool

Returns true if it has the AUTOGROW flag set.

pub const fn is_vscroll(&self) -> bool

Returns true if it has the VSCROLL flag set.

Trait Implementations

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<NcPlaneOptionsBuilder> for NcPlaneOptions

fn from(builder: NcPlaneOptionsBuilder) -> NcPlaneOptions

Performs the conversion.