Struct libnotcurses_sys::c_api::ffi::ncselector_options

#[repr(C)]
pub struct ncselector_options {
    pub title: *const c_char,
    pub secondary: *const c_char,
    pub footer: *const c_char,
    pub items: *const ncselector_item,
    pub defidx: c_uint,
    pub maxdisplay: c_uint,
    pub opchannels: u64,
    pub descchannels: u64,
    pub titlechannels: u64,
    pub footchannels: u64,
    pub boxchannels: u64,
    pub flags: u64,
}

Fields

title: *const c_char

title may be NULL, inhibiting riser, saving two rows.

secondary: *const c_char

secondary may be NULL

footer: *const c_char

footer may be NULL

items: *const ncselector_item

initial items and descriptions

defidx: c_uint

default item (selected at start), must be < itemcount unless itemcount is 0, in which case ‘defidx’ must also be 0

maxdisplay: c_uint

maximum number of options to display at once, 0 to use all available space

opchannels: u64

option channels

descchannels: u64

description channels

titlechannels: u64

title channels

footchannels: u64

secondary and footer channels

boxchannels: u64

border channels

flags: u64

bitfield of NCSELECTOR_OPTION_*, currently unused

Implementations

impl ncselector_options

NcMenuOptions constructors

pub fn new(items: &[NcSelectorItem]) -> Self

New NcSelectorOptions with just the list of items.

pub fn with_all_options( title: Option<&NcString>, secondary: Option<&NcString>, footer: Option<&NcString>, items: &[NcSelectorItem], default: u32, max_display: u32, opchannels: impl Into<NcChannels>, descchannels: impl Into<NcChannels>, titlechannels: impl Into<NcChannels>, footchannels: impl Into<NcChannels>, boxchannels: impl Into<NcChannels> ) -> Self

New NcSelectorOptions with all options.

Trait Implementations

impl Debug for ncselector_options

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

Formats the value using the given formatter.

impl Default for ncselector_options

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ncselector_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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ncselector_options

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ncselector_options> for ncselector_options

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ncselector_options> for ncselector_options

fn partial_cmp(&self, other: &ncselector_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 ncselector_options

impl StructuralEq for ncselector_options

impl StructuralPartialEq for ncselector_options