rat-widget 3.2.1

ratatui widgets extended edition
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

#![doc = include_str!("../readme.md")]
//
#![allow(clippy::collapsible_else_if)]
#![allow(clippy::collapsible_if)]
#![allow(clippy::if_same_then_else)]
#![allow(clippy::clone_on_copy)]
#![allow(clippy::assigning_clones)]
#![allow(clippy::question_mark)]
#![allow(clippy::uninlined_format_args)]

pub mod event {
    //!
    //! Event-handler traits and Keybindings.
    //!
    //! See [rat-event](https://docs.rs/rat-event/latest/rat_event/)
    //!
    pub use rat_event::*;

    pub use crate::button::event::ButtonOutcome;
    pub use crate::calendar::event::CalOutcome;
    pub use crate::checkbox::event::CheckOutcome;
    pub use crate::choice::event::ChoiceOutcome;
    pub use crate::combobox::event::ComboboxOutcome;
    pub use crate::file_dialog::event::FileOutcome;
    pub use crate::form::event::FormOutcome;
    pub use crate::radio::event::RadioOutcome;
    pub use crate::slider::event::SliderOutcome;
    pub use crate::tabbed::event::TabbedOutcome;
    pub use rat_ftable::event::{DoubleClickOutcome, EditOutcome, TableOutcome};
    pub use rat_menu::event::MenuOutcome;
    pub use rat_popup::event::PopupOutcome;
    pub use rat_scrolled::event::ScrollOutcome;
    pub use rat_text::event::{ReadOnly, TextOutcome};
}

/// Module for focus-handling functionality.
/// See [rat-focus](https://docs.rs/rat-focus)
pub mod focus {
    pub use rat_focus::{
        Focus, FocusBuilder, FocusFlag, HasFocus, Navigation, handle_focus, impl_has_focus,
        match_focus, on_gained, on_lost,
    };
}

/// Layout calculations apart from ratatui/Layout.
pub mod layout;

/// Trait for relocatable widgets.
/// See also [rat-reloc](https://docs.rs/rat-reloc/latest/rat_reloc/)
pub mod reloc {
    pub use rat_reloc::{
        RelocatableState, impl_relocatable_state, relocate_area, relocate_areas,
        relocate_pos_tuple, relocate_pos_tuple_opt, relocate_position, relocate_positions,
    };
}

/// Scroll attribute and event-handling.
/// See [rat-scrolled](https://docs.rs/rat-scrolled/latest/rat_scrolled/)
pub mod scrolled {
    pub use rat_scrolled::{
        SCROLLBAR_DOUBLE_HORIZONTAL, SCROLLBAR_DOUBLE_VERTICAL, SCROLLBAR_HORIZONTAL,
        SCROLLBAR_VERTICAL, Scroll, ScrollArea, ScrollAreaState, ScrollState, ScrollStyle,
        ScrollSymbols, ScrollbarPolicy,
    };
}

/// Text editing core functionality and utilities.
pub mod text {
    pub use rat_text::clipboard;
    pub use rat_text::core;
    pub use rat_text::cursor;
    pub use rat_text::undo_buffer;
    pub use rat_text::{
        Cursor, Grapheme, HasScreenCursor, Locale, TextError, TextFocusGained, TextFocusLost,
        TextPosition, TextRange, TextStyle, TextTab, impl_screen_cursor, ipos_type, screen_cursor,
        upos_type,
    };
}

// --- widget modules here --- (alphabetical)

pub mod button;
pub mod calendar;
pub mod checkbox;
pub mod choice;
pub mod clipper;
pub mod combobox;
pub mod date_input;
pub mod dialog_frame;
pub mod file_dialog;
pub mod form;
pub mod hover;
pub mod line_number;
pub mod list;
pub mod menu;
pub mod msgdialog;
pub mod number_input;
pub mod paired;
pub mod paragraph;
pub mod popup;
pub mod radio;
pub mod range_op;
pub mod shadow;
pub mod slider;
pub mod splitter;
pub mod statusline;
pub mod statusline_stacked;
pub mod tabbed;
pub mod table;
pub mod text_input;
pub mod text_input_mask;
pub mod textarea;
pub mod toolbar;
pub mod util;
pub mod view;

mod _private {
    #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct NonExhaustive;
}