libnotcurses-sys 3.3.0

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

//! `NcReader` widget.

// functions already exported by bindgen : 11
// ------------------------------------------
//  ncreader_clear
//  ncreader_contents
//  ncreader_create
//  ncreader_destroy
//  ncreader_move_down
//  ncreader_move_left
//  ncreader_move_right
//  ncreader_move_up
//  ncreader_offer_input
//  ncreader_plane
//  ncreader_write_egc

use crate::c_api::ffi;

mod methods;

/// Provides a freeform input in a (possibly multiline) region
///
/// Supports optional readline keybindings (opt out using
/// `NCREADER_OPTION_NOCMDKEYS` flag)
///
/// Takes ownership of its [`NcPlane`][crate::NcPlane], destroying it on any
/// error (otherwise [`destroy`][NcReader#method.destroy] destroys the plane).
///
/// `type in C: ncreader (struct)`
pub type NcReader = ffi::ncreader;

/// Options struct for [`NcReader`]
///
/// `type in C: ncreader_options (struct)`
pub type NcReaderOptions = ffi::ncreader_options;

impl NcReaderOptions {
    /// Makes the terminal cursor visible across the lifetime of the ncreader, and
    /// have the ncreader manage the cursor's placement.
    pub const CURSOR: u32 = c_api::NCREADER_OPTION_CURSOR;

    /// Enables horizontal scrolling. Virtual lines can then grow arbitrarily long.
    pub const HORSCROLL: u32 = c_api::NCREADER_OPTION_HORSCROLL;

    /// Disables all editing shortcuts. By default, emacs-style keys are available.
    pub const NOCMDKEYS: u32 = c_api::NCREADER_OPTION_NOCMDKEYS;

    /// Enables vertical scrolling. You can then use arbitrarily many virtual lines.
    pub const VERSCROLL: u32 = c_api::NCREADER_OPTION_VERSCROLL;
}

pub(crate) mod c_api {
    use super::ffi;

    /// Makes the terminal cursor visible across the lifetime of the ncreader, and
    /// have the ncreader manage the cursor's placement.
    pub const NCREADER_OPTION_CURSOR: u32 = ffi::NCREADER_OPTION_CURSOR;

    /// Enables horizontal scrolling. Virtual lines can then grow arbitrarily long.
    pub const NCREADER_OPTION_HORSCROLL: u32 = ffi::NCREADER_OPTION_HORSCROLL;

    /// Disables all editing shortcuts. By default, emacs-style keys are available.
    pub const NCREADER_OPTION_NOCMDKEYS: u32 = ffi::NCREADER_OPTION_NOCMDKEYS;

    /// Enables vertical scrolling. You can then use arbitrarily many virtual lines.
    pub const NCREADER_OPTION_VERSCROLL: u32 = ffi::NCREADER_OPTION_VERSCROLL;
}