Struct libnotcurses_sys::c_api::ffi::ncplane_options

#[repr(C)]
pub struct ncplane_options {
    pub y: c_int,
    pub x: c_int,
    pub rows: c_uint,
    pub cols: c_uint,
    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_uint,
    pub margin_r: c_uint,
}

Fields

y: c_int

vertical placement relative to parent plane

x: c_int

horizontal placement relative to parent plane

rows: c_uint

rows, must be >0 unless NCPLANE_OPTION_MARGINALIZED

cols: c_uint

columns, must be >0 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_uint

margins (require NCPLANE_OPTION_MARGINALIZED)

margin_r: c_uint

margins (require NCPLANE_OPTION_MARGINALIZED)

Implementations

impl ncplane_options

Constructors

pub fn new(y: i32, x: i32, rows: u32, cols: u32) -> Self

New NcPlaneOptions using the horizontal x.

pub fn builder() -> NcPlaneOptionsBuilder

Returns a default NcPlane options builder.

pub fn to_builder(&self) -> NcPlaneOptionsBuilder

Returns a builder object from the current NcPlane options.

pub fn new_aligned(y: i32, align: impl Into<NcAlign>, rows: u32, cols: u32) -> Self

New NcPlaneOptions with horizontal alignment.

pub fn with_flags(
    y: i32,
    x: i32,
    rows: u32,
    cols: u32,
    resizecb: Option<NcResizeCb>,
    flags: impl Into<NcPlaneFlag>,
    margin_b: u32,
    margin_r: u32
) -> Self

New NcPlaneOptions, with flags.

pub fn with_flags_aligned(
    y: i32,
    align: impl Into<NcAlign>,
    rows: u32,
    cols: u32,
    resizecb: Option<NcResizeCb>,
    flags: impl Into<NcPlaneFlag>
) -> Self

New NcPlaneOptions, with flags and horizontal alignment.

Note: Already includes the NcPlaneOptions::HORALIGNED flag.

impl ncplane_options

Methods

pub fn is_veraligned(&self) -> bool

Returns true if it has the VerAligned flag set.

pub fn is_horaligned(&self) -> bool

Returns true if it has the HorAligned flag set.

pub fn is_marginalized(&self) -> bool

Returns true if it has the Marginalized flag set.

pub fn is_fixed(&self) -> bool

Returns true if it has the Fixed flag set.

pub fn is_autogrow(&self) -> bool

Returns true if it has the AutoGrow flag set.

pub fn is_vscroll(&self) -> bool

Returns true if it has the VScroll flag set.

Trait Implementations

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

fn from(options: NcPlaneOptions) -> NcPlaneOptionsBuilder

Converts to this type from the input 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.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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.

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

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

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

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

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

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

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 Eq for ncplane_options

impl StructuralEq for ncplane_options

impl StructuralPartialEq for ncplane_options