libnotcurses_sys/widgets/selector/mod.rs
1//! `NcSelector` widget.
2//! ╭──────────────────────────╮
3//! │This is the primary header│
4//! ╭──────────────────────this is the secondary header──────╮
5//! │ ↑ │
6//! │ option1 Long text #1 │
7//! │ option2 Long text #2 │
8//! │ option3 Long text #3 │
9//! │ option4 Long text #4 │
10//! │ option5 Long text #5 │
11//! │ option6 Long text #6 │
12//! │ ↓ │
13//! ╰────────────────────────────────────here's the footer───╯
14//!
15//! selection widget -- an ncplane with a title header and a body section. the
16//! body section supports infinite scrolling up and down.
17//!
18//! At all times, exactly one item is selected.
19
20use crate::c_api::ffi;
21
22mod builder;
23mod methods;
24
25pub use builder::NcSelectorBuilder;
26
27/// High-level widget for selecting one item from a set.
28pub type NcSelector = ffi::ncselector;
29
30/// Options structure for [`NcSelector`].
31pub type NcSelectorOptions = ffi::ncselector_options;
32
33/// Item structure for [`NcSelector`].
34pub type NcSelectorItem = ffi::ncselector_item;