text-document-frontend 1.1.1

Frontend integration layer and command wrappers for text-document
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

// Generated by Qleany v1.4.8 from frontend_undo_redo_commands.tera
//! Undo/Redo commands
#![allow(unused_imports, dead_code)]

use crate::app_context::AppContext;
use anyhow::{Context, Result};

/// Undoes the most recent command on the specified stack.
pub fn undo(ctx: &AppContext, stack_id: Option<u64>) -> Result<()> {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    // Inject event hub before operation
    undo_redo_manager.set_event_hub(&ctx.event_hub);

    undo_redo_manager.undo(stack_id).context("undo")
}

/// Redoes the most recently undone command on the specified stack.
pub fn redo(ctx: &AppContext, stack_id: Option<u64>) -> Result<()> {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.set_event_hub(&ctx.event_hub);

    undo_redo_manager.redo(stack_id).context("redo")
}

/// Checks if there are commands that can be undone on the specified stack.
pub fn can_undo(ctx: &AppContext, stack_id: Option<u64>) -> bool {
    let undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.can_undo(stack_id)
}

/// Checks if there are commands that can be redone on the specified stack.
pub fn can_redo(ctx: &AppContext, stack_id: Option<u64>) -> bool {
    let undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.can_redo(stack_id)
}

/// Begins a composite command group.
pub fn begin_composite(ctx: &AppContext, stack_id: Option<u64>) {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.set_event_hub(&ctx.event_hub);
    undo_redo_manager.begin_composite(stack_id);
}

/// Ends the current composite command group and adds it to the specified stack.
pub fn end_composite(ctx: &AppContext) {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.set_event_hub(&ctx.event_hub);
    undo_redo_manager.end_composite();
}

/// Cancels the current composite command group, before it is saved to the stack.
pub fn cancel_composite(ctx: &AppContext) {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.set_event_hub(&ctx.event_hub);
    undo_redo_manager.cancel_composite();
}

/// Clears the undo and redo stacks for a specific stack ID.
pub fn clear_stack(ctx: &AppContext, stack_id: u64) {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.clear_stack(stack_id);
}

/// Clears the undo and redo stacks.
pub fn clear_all_stacks(ctx: &AppContext) {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.clear_all_stacks();
}

/// Gets the size of the undo stack.
pub fn get_stack_size(ctx: &AppContext, stack_id: u64) -> usize {
    let undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.get_stack_size(stack_id)
}

/// Creates a new undo/redo stack and returns its ID.
pub fn create_new_stack(ctx: &AppContext) -> u64 {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager.create_new_stack()
}

/// Deletes an undo/redo stack by its ID.
pub fn delete_stack(ctx: &AppContext, stack_id: u64) -> Result<()> {
    let mut undo_redo_manager = ctx.undo_redo_manager.lock().unwrap();
    undo_redo_manager
        .delete_stack(stack_id)
        .context("deleting undo/redo stack")
}