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

//! `NcReel` widget.

use crate::c_api::ffi;

/// A wheel with [`NcTablet`]s on the outside.
///
/// An `NcReel` is projected onto the 2d rendering area, showing some portion of
/// the `NcReel`, and zero or more `NcTablet`s.
///
/// An `NcReel` is a [`Nc`][crate::Nc] region devoted to displaying zero or more
/// line-oriented, contained [`NcTablet`]s between which the user may navigate.
///
/// If at least one `NcTablet`s exists, there is a "focused tablet".
/// As much of the focused tablet as is possible is always displayed.
///
/// If there is space left over, other tablets are included in the display.
/// Tablets can come and go at any time, and can grow or shrink at any time.
pub type NcReel = ffi::ncreel;

/// Options struct for [`NcReel`]
pub type NcReelOptions = ffi::ncreel_options;

/// Visual tablet for [`NcReel`]
pub type NcTablet = ffi::nctablet;

impl NcReelOptions {
    /// is navigation circular (does moving down from the last tablet move to the
    /// first, and vice versa)? only meaningful when infinitescroll is true. if
    /// infinitescroll is false, this must be false.
    pub const CIRCULAR: u32 = c_api::NCREEL_OPTION_CIRCULAR;
    /// is scrolling infinite (can one move down or up forever, or is an end
    /// reached?). if true, 'circular' specifies how to handle the special case of
    /// an incompletely-filled reel.
    pub const INFINITESCROLL: u32 = c_api::NCREEL_OPTION_INFINITESCROLL;
}

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

    /// is navigation circular (does moving down from the last tablet move to the
    /// first, and vice versa)? only meaningful when infinitescroll is true. if
    /// infinitescroll is false, this must be false.
    pub const NCREEL_OPTION_CIRCULAR: u32 = ffi::NCREEL_OPTION_CIRCULAR;
    /// is scrolling infinite (can one move down or up forever, or is an end
    /// reached?). if true, 'circular' specifies how to handle the special case of
    /// an incompletely-filled reel.
    pub const NCREEL_OPTION_INFINITESCROLL: u32 = ffi::NCREEL_OPTION_INFINITESCROLL;
}