rsvim_core 0.1.2

The core library for RSVIM text editor.
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

//! Basic atom of all UI components.

use crate::prelude::*;
use crate::ui::canvas::Canvas;
use crate::ui::tree::TreeNodeId;
use crate::ui::viewport::{CursorViewportArc, ViewportArc};
use crate::ui::widget::window::opt::WindowOptions;

pub mod command_line;
pub mod cursor;
pub mod root;
pub mod window;

#[cfg(test)]
mod window_tests;

/// Base trait for all UI widgets.
pub trait Widgetable {
  /// Draw the widget to canvas, on the specific shape.
  fn draw(&self, _canvas: &mut Canvas) {
    // Do nothing.
    // trace!("draw canvas");
  }
}

/// Generate enum dispatcher for `Widget`.
#[macro_export]
macro_rules! widget_enum_dispatcher {
  ($enum:ident, $($variant:tt),*) => {
    impl Widgetable for $enum {
      fn draw(&self, canvas: &mut Canvas) {
        match self {
          $(
            $enum::$variant(w) => w.draw(canvas),
          )*
        }
      }
    }
  }
}

pub trait EditableWidgetable {
  fn editable_viewport(&self) -> ViewportArc;

  fn set_editable_viewport(&mut self, viewport: ViewportArc);

  fn editable_cursor_viewport(&self) -> CursorViewportArc;

  fn set_editable_cursor_viewport(
    &mut self,
    cursor_viewport: CursorViewportArc,
  );

  fn editable_options(&self) -> &WindowOptions;

  fn editable_actual_shape(&self) -> &U16Rect;

  fn move_editable_cursor_to(&mut self, x: isize, y: isize) -> Option<IRect>;

  fn editable_cursor_id(&self) -> Option<TreeNodeId>;
}