Struct libnotcurses_sys::c_api::ffi::ncmenu_options

#[repr(C)]
pub struct ncmenu_options {
    pub sections: *mut ncmenu_section,
    pub sectioncount: c_int,
    pub headerchannels: u64,
    pub sectionchannels: u64,
    pub flags: u64,
}

Fields

sections: *mut ncmenu_section

array of ‘sectioncount’ menu_sections

sectioncount: c_int

must be positive

headerchannels: u64

styling for header

sectionchannels: u64

styling for sections

flags: u64

flag word of NCMENU_OPTION_*

Implementations

impl ncmenu_options

NcMenuOptions constructors

pub fn new(sections: &mut [NcMenuSection]) -> Self

New NcMenuOptions for NcMenu.

sections must contain at least 1 NcMenuSection.

pub fn with_all_args<CHS1, CHS2>(
    sections: &mut [NcMenuSection],
    style_header: CHS1,
    style_sections: CHS2,
    flags: u64
) -> Self where
    CHS1: Into<NcChannels>,
    CHS2: Into<NcChannels>, 

New NcMenuOptions for NcMenu, with all args.

sections must contain at least 1 NcMenuSection.

impl ncmenu_options

NcMenuOptions methods

pub fn header_channels(&self) -> NcChannels

Returns the styling for the header.

(No equivalent C style function)

pub fn header_channels_mut(&mut self) -> &mut NcChannels_u64

Returns a mutable reference of the styling for the sections.

(No equivalent C style function)

pub fn section_channels(&self) -> NcChannels

Returns the styling for the sections.

(No equivalent C style function)

pub fn section_channels_mut(&mut self) -> &mut NcChannels_u64

Returns a mutable reference of the styling for the sections.

(No equivalent C style function)

impl ncmenu_options

pub const BOTTOM: u64 = 1u64

NcMenuOptions flag: Bottom row (as opposed to top row).

pub const HIDING: u64 = 2u64

NcMenuOptions flag: Hides the menu when not unrolled.

Trait Implementations

impl Debug for ncmenu_options

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

Formats the value using the given formatter.

impl Default for ncmenu_options

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ncmenu_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 ncmenu_options

fn cmp(&self, other: &ncmenu_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<ncmenu_options> for ncmenu_options

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

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

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

This method tests for !=.

impl PartialOrd<ncmenu_options> for ncmenu_options

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

impl StructuralEq for ncmenu_options

impl StructuralPartialEq for ncmenu_options