libnotcurses-sys 3.9.1

Low-level Rust bindings for the notcurses C library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! `NcMenu` widget

// functions already exported by bindgen : 13
// ------------------------------------------
// (#) test:  0
// (W) wrap: 13
// ------------------------------------------
//W ncmenu_create
//W ncmenu_destroy
//W ncmenu_item_set_status
//W ncmenu_mouse_selected
//W ncmenu_nextitem
//W ncmenu_nextsection
//W ncmenu_offer_input
//W ncmenu_plane
//W ncmenu_previtem
//W ncmenu_prevsection
//W ncmenu_rollup
//W ncmenu_selected
//W ncmenu_unroll

use crate::c_api::ffi;

mod methods;

/// menus on the top or bottom rows
///
/// An [Nc][crate::Nc] instance supports menu bars on the top or bottom row
/// of the true screen.
///
/// An NcMenu is composed of [`NcMenuSection`]s, which are in turn composed of
/// [`NcMenuItem`]s.
///
/// Either no sections are visible, and the menu is rolled up, or exactly one
/// section is unrolled.
///
/// - [rollup()][NcMenu#method.rollup]
///     places an `NcMenu` in the rolled up state.
/// - [unroll()][NcMenu#method.unroll]
///     rolls up any unrolled section and unrolls the specified one.
/// - [destroy()][NcMenu#method.destroy]
///     removes a menu bar, and frees all associated resources.
///
/// `type in C: ncmenu (struct)`
pub type NcMenu = ffi::ncmenu;

/// Options struct for [`NcMenu`].
pub type NcMenuOptions = ffi::ncmenu_options;

/// Item for [`NcMenu`].
pub type NcMenuItem = ffi::ncmenu_item;

/// Section for [`NcMenu`].
pub type NcMenuSection = ffi::ncmenu_section;

impl NcMenuOptions {
    /// [`NcMenuOptions`] flag: Bottom row (as opposed to top row).
    pub const BOTTOM: u64 = c_api::NCMENU_OPTION_BOTTOM;

    /// [`NcMenuOptions`] flag: Hides the menu when not unrolled.
    pub const HIDING: u64 = c_api::NCMENU_OPTION_HIDING;
}

pub(crate) mod c_api {
    use super::ffi;
    #[allow(unused_imports)]
    use super::NcMenuOptions;

    /// [`NcMenuOptions`] flag: Bottom row (as opposed to top row).
    pub const NCMENU_OPTION_BOTTOM: u64 = ffi::NCMENU_OPTION_BOTTOM as u64;

    /// [`NcMenuOptions`] flag: Hides the menu when not unrolled.
    pub const NCMENU_OPTION_HIDING: u64 = ffi::NCMENU_OPTION_HIDING as u64;
}