Type Definition libnotcurses_sys::NcOptions

pub type NcOptions = notcurses_options;

Options struct for Nc.

Fields

• termtype: The name of the terminfo database entry describing this terminal.
• loglevel: stderr output NcLogLevel.
• margin_t: Desirable top margin.
• margin_r: Desirable right margin.
• margin_b: Desirable bottom margin.
• margin_l: Desirable left margin.
• flags: NcFlag flags.

Implementations

impl NcOptions

constructors

pub fn builder() -> NcOptionsBuilder

Returns a default Nc options builder.

pub fn to_builder(&self) -> NcOptionsBuilder

Returns a builder object from the current Nc options.

pub fn new() -> Self

New NcOptions.

pub fn with_margins(top: u32, right: u32, bottom: u32, left: u32) -> Self

New NcOptions, with margins.

pub fn with_flags(flags: NcFlag) -> Self

New NcOptions, with flags.

pub fn with_all_options(
    loglevel: NcLogLevel,
    trbl_margins: Option<(u32, u32, u32, u32)>,
    flags: NcFlag
) -> NcOptions

New NcOptions, with flags

impl NcOptions

methods

pub fn margins(&self) -> (u32, u32, u32, u32)

Returns the (top, right, bottom, left) margins.

pub fn log_level(&self) -> NcLogLevel

Returns the log level.

pub fn is_drain_input(&self) -> bool

Returns true if it has the DrainInput flag set.

pub fn is_inhibit_set_locale(&self) -> bool

Returns true if it has the InhibitSetLocale flag set.

pub fn is_no_alternate_screen(&self) -> bool

Returns true if it has the NoAlternateScreen flag set.

pub fn is_no_clear_bitmaps(&self) -> bool

Returns true if it has the NoClearBitmaps flag set.

pub fn is_no_font_changes(&self) -> bool

Returns true if it has the NoFontChanges flag set.

pub fn is_no_quit_sig_handlers(&self) -> bool

Returns true if it has the NoQuitSigHandlers flag set.

pub fn is_no_winch_sig_handler(&self) -> bool

Returns true if it has the NoWinchSigHandler flag set.

pub fn is_preserve_cursor(&self) -> bool

Returns true if it has the PreserveCursor flag set.

pub fn is_scrolling(&self) -> bool

Returns true if it has the Scrolling flag set.

pub fn is_cli_mode(&self) -> bool

Returns true if it has the CliMode flag set.

pub fn is_suppress_banners(&self) -> bool

Returns true if it has the SuppressBanners flag set.

Trait Implementations

impl From<&NcOptionsBuilder> for NcOptions

fn from(builder: &NcOptionsBuilder) -> Self

Converts to this type from the input type.

impl From<&mut NcOptionsBuilder> for NcOptions

fn from(builder: &mut NcOptionsBuilder) -> Self

Converts to this type from the input type.

impl From<NcOptionsBuilder> for NcOptions

fn from(builder: NcOptionsBuilder) -> NcOptions

Converts to this type from the input type.