cursivext 0.0.0

Some useful extensions for Cursive TUI.
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
121
122
123
124
125
126
127
128
129
130
131
132

use cursive::{
  self, Vec2, View,
  direction::Direction,
  event::{Event, EventResult, Key, MouseButton, MouseEvent},
  theme::PaletteStyle,
  utils::markup::StyledString,
  view::CannotFocus,
  views::{self, DummyView, LinearLayout, TextView},
};

#[derive(Default)]
pub struct Checkbox(pub views::Checkbox);

impl core::ops::DerefMut for Checkbox {
  fn deref_mut(&mut self) -> &mut Self::Target {
    &mut self.0
  }
}

impl core::ops::Deref for Checkbox {
  type Target = views::Checkbox;
  fn deref(&self) -> &Self::Target {
    &self.0
  }
}

impl Checkbox {
  /// Constructs new checkbox.
  ///
  /// # Example
  ///
  /// ```
  /// use cursivext::views::Checkbox;
  ///
  /// let checkbox = Checkbox::new();
  /// ```
  pub fn new() -> Self {
    Self(views::Checkbox::new())
  }

  /// Creates horizontally aligned checkbox with label.
  ///
  /// Typical UI pattern combining checkbox, spacing and text label
  ///
  /// # Parameter
  ///
  /// - label
  ///   - Text displayed next to checkbox (supports styled strings)
  ///
  /// # Example
  ///
  /// ```
  /// use cursivext::{cursive, views::Checkbox};
  /// use cursive::{With, views::Panel};
  ///
  /// let checkbox = Checkbox::wrap_linear_layout("good?").wrap_with(Panel::new);
  ///
  /// cursive::default()
  ///   .with(|siv| siv.add_layer(checkbox));
  ///   // .run();
  ///
  ///   // => [✔︎] good?
  /// ```
  pub fn wrap_linear_layout<S: Into<StyledString>>(label: S) -> LinearLayout {
    LinearLayout::horizontal()
      .child(Checkbox::new())
      .child(DummyView)
      .child(TextView::new(label))
  }

  fn draw_internal(&self, printer: &cursive::Printer) {
    printer.print((0, 0), "[ ]");
    if self.is_checked() {
      printer.print((1, 0), "✔︎");
    }
  }
}

impl View for Checkbox {
  fn required_size(&mut self, _: Vec2) -> Vec2 {
    Vec2::new(3, 1)
  }

  fn take_focus(&mut self, _: Direction) -> Result<EventResult, CannotFocus> {
    self
      .is_enabled()
      .then(EventResult::consumed)
      .ok_or(CannotFocus)
  }

  fn draw(&self, printer: &cursive::Printer) {
    match self.is_enabled() && printer.enabled {
      true => printer
        .with_selection(printer.focused, |printer| self.draw_internal(printer)),
      _ => printer.with_style(PaletteStyle::Secondary, |printer| {
        self.draw_internal(printer)
      }),
    }
  }

  fn on_event(&mut self, event: Event) -> EventResult {
    if !self.is_enabled() {
      return EventResult::Ignored;
    }
    match event {
      Event::Key(Key::Enter) | Event::Char(' ') => self.toggle(),
      Event::Mouse {
        event: MouseEvent::Release(MouseButton::Left),
        position,
        offset,
      } if position.fits_in_rect(offset, (3, 1)) => self.toggle(),
      _ => EventResult::Ignored,
    }
  }
}

#[cfg(test)]
mod tests {
  use cursive::{With, views::Panel};

  use super::*;

  #[ignore]
  #[test]
  fn test_show_checkbox() {
    let checkbox = Checkbox::wrap_linear_layout("good?").wrap_with(Panel::new);

    cursive::default()
      .with(|siv| siv.add_layer(checkbox))
      .run()
  }
}