Interface UndoHistoryBase

The base interface for undo histories.

interface UndoHistoryBase {
    add(undoable): void;
    clear(): void;
    getLastOrEmptyRedoMessage(): string;
    getLastOrEmptyUndoMessage(): string;
    getLastRedo(): undefined | Undoable;
    getLastRedoMessage(): undefined | string;
    getLastUndo(): undefined | Undoable;
    getLastUndoMessage(): undefined | string;
    redo(): void;
    redosObservable(): Observable<undefined | Undoable>;
    undo(): void;
    undosObservable(): Observable<undefined | Undoable>;
}

Implemented by

Index

Methods

add clear getLastOrEmptyRedoMessage getLastOrEmptyUndoMessage getLastRedo getLastRedoMessage getLastUndo getLastUndoMessage redo redosObservable undo undosObservable

Methods

add

add(undoable): void
Adds an undoable object to the collector.
Parameters
- undoable: Undoable
  The undoable object to add.
Returns void
- Defined in api/undo/UndoHistoryBase.ts:42

clear

clear(): void
Removes all the undoable objects of the collector.

Returns void
- Defined in api/undo/UndoHistoryBase.ts:36

getLastOrEmptyRedoMessage

getLastOrEmptyRedoMessage(): string
Returns string
The last redoable object name or an empty string if there is no last object.
- Defined in api/undo/UndoHistoryBase.ts:72

getLastOrEmptyUndoMessage

getLastOrEmptyUndoMessage(): string
Returns string
The last undoable object name or an empty string if there is no last object.
- Defined in api/undo/UndoHistoryBase.ts:67

getLastRedo

getLastRedo(): undefined | Undoable
Returns undefined | Undoable
The last redoable object or undefined if there is no last object.
- Defined in api/undo/UndoHistoryBase.ts:52

getLastRedoMessage

getLastRedoMessage(): undefined | string
Returns undefined | string
The last redoable object name or undefined if there is no last object.
- Defined in api/undo/UndoHistoryBase.ts:62

getLastUndo

getLastUndo(): undefined | Undoable
Returns undefined | Undoable
The last undoable object or undefined if there is no last object.
- Defined in api/undo/UndoHistoryBase.ts:47

getLastUndoMessage

getLastUndoMessage(): undefined | string
Returns undefined | string
The last undoable object name or undefined if there is no last object.
- Defined in api/undo/UndoHistoryBase.ts:57

redo

redo(): void
Redoes the last undoable object.

Returns void
- Defined in api/undo/UndoHistoryBase.ts:31

redosObservable

redosObservable(): Observable<undefined | Undoable>
A stream for observing changes regarding the last redoable object.

Returns Observable<undefined | Undoable>
An observable value of optional redoable objects: if empty, this means that no redoable object are stored anymore.
- Defined in api/undo/UndoHistoryBase.ts:86

undo

undo(): void
Undoes the last undoable object.

Returns void
- Defined in api/undo/UndoHistoryBase.ts:26

undosObservable

undosObservable(): Observable<undefined | Undoable>
A stream for observing changes regarding the last undoable object.

Returns Observable<undefined | Undoable>
An observable value of optional undoable objects: if empty, this means that no undoable object are stored anymore.
- Defined in api/undo/UndoHistoryBase.ts:79

Generated using TypeDoc