Struct libnotcurses_sys::ffi::ncplane_options

#[repr(C)]
pub struct ncplane_options {
    pub y: c_int,
    pub x: c_int,
    pub rows: c_int,
    pub cols: c_int,
    pub userptr: *mut c_void,
    pub name: *const c_char,
    pub resizecb: Option<unsafe extern "C" fn(arg1: *mut ncplane) -> c_int>,
    pub flags: u64,
    pub margin_b: c_int,
    pub margin_r: c_int,
}

Fields

y: c_int

vertical placement relative to parent plane

x: c_int

horizontal placement relative to parent plane

rows: c_int

rows, must be positive (unless NCPLANE_OPTION_MARGINALIZED)

cols: c_int

columns, must be positive (unless NCPLANE_OPTION_MARGINALIZED)

userptr: *mut c_void

user curry, may be NULL

name: *const c_char

name (used only for debugging), may be NULL

resizecb: Option<unsafe extern "C" fn(arg1: *mut ncplane) -> c_int>

callback when parent is resized

flags: u64

closure over NCPLANE_OPTION_*

margin_b: c_int

margins (require NCPLANE_OPTION_MARGINALIZED)

margin_r: c_int

margins (require NCPLANE_OPTION_MARGINALIZED)

Implementations

impl ncplane_options

NcPlaneOptions Constructors

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

New NcPlaneOptions using the horizontal x.

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: NcOffset,
    margin_r: NcOffset
) -> 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 NCPLANE_OPTION_HORALIGNED flag.

Trait Implementations

impl Clone for ncplane_options

fn clone(&self) -> ncplane_options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ncplane_options

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

Formats the value using the given formatter.

impl Default for ncplane_options

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ncplane_options

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ncplane_options

fn cmp(&self, other: &ncplane_options) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ncplane_options> for ncplane_options

fn eq(&self, other: &ncplane_options) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ncplane_options) -> bool

This method tests for !=.

impl PartialOrd<ncplane_options> for ncplane_options

fn partial_cmp(&self, other: &ncplane_options) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ncplane_options

impl Eq for ncplane_options

impl StructuralEq for ncplane_options

impl StructuralPartialEq for ncplane_options