lineeditor 0.4.1

A cross platform rich line 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
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

/// Editing actions which can be mapped to key bindings.
///
/// Executed by `Editor::run_edit_commands()`
#[derive(Clone)]
pub enum EditCommand {
    /// Insert a character at the current insertion point
    InsertChar(char),

    /// Insert a string at the current insertion point
    InsertString(String),

    /// Backspace delete from the current insertion point
    DeleteLeftChar,

    /// Delete in-place from the current insertion point
    DeleteRightChar,

    /// Delete in-place range
    DeleteSpan(usize, usize),

    /// Clear the current buffer
    Clear,
}

/// Movements actions which can be mapped to key bindings.
#[derive(Clone)]
pub enum MovementCommand {
    /// Move to the start of the buffer
    MoveToStart,

    /// Move to the end of the buffer
    MoveToEnd,

    /// Move one character to the left
    MoveLeftChar,

    /// Move one character to the right
    MoveRightChar,

    /// Move one word to the left
    MoveLeftWord,

    /// Move one word to the right
    MoveRightWord,

    /// Move to position
    MoveToPosition(usize),
}

/// LineEditor supported actions.
#[derive(Clone)]
pub enum LineEditorEvent {
    /// No op event
    None,

    /// Handle enter event
    Enter,

    /// Esc event
    Esc,

    /// Handle unconditional submit event
    Submit,

    /// Run these commands in the editor
    Edit(Vec<EditCommand>),

    /// Run movements commands in the editor
    Movement(Vec<MovementCommand>),

    /// Move up to the previous line, if multiline, or up into the historic buffers
    Up,

    /// Move down to the next line, if multiline, or down through the historic buffers
    Down,

    /// Move right to the next column, completion entry, or complete hint
    Right,

    /// Move left to the next column, or completion entry
    Left,

    /// Select one character to the right
    SelectRight,

    /// Select one character to the left
    SelectLeft,

    /// Select all buffer
    SelectAll,

    /// Cut the selected text into clipboard
    CutSelected,

    /// Copy the selected text into clipboard
    CopySelected,

    /// Paste text from clipboard into selection or at insertion point
    Paste,

    /// Delete char from the left or delete selected range
    Backspace,

    /// Delete char from the right or delete selected range
    Delete,

    /// Show or Hide Auto Complete view depend on the state
    ToggleAutoComplete,
}