Audacity 3.2.0
Public Types | Public Attributes | List of all members
UndoRedoMessage Struct Reference

Type of message published by UndoManager. More...

#include <UndoManager.h>

Public Types

enum  Type {
  Pushed , Modified , Renamed , UndoOrRedo ,
  Reset , Purge , BeginPurge , EndPurge
}
 

Public Attributes

enum UndoRedoMessage::Type type
 
const size_t begin = 0
 Only significant for BeginPurge messages. More...
 
const size_t end = 0
 

Detailed Description

Type of message published by UndoManager.

all are published only during idle time, except BeginPurge and EndPurge

Definition at line 61 of file UndoManager.h.

Member Enumeration Documentation

◆ Type

Enumerator
Pushed 

Project state did not change, but a new state was copied into Undo history and any redo states were lost

Modified 

Project state did not change, but current state was modified in Undo history

Renamed 

Project state did not change, but current state was renamed in Undo history

UndoOrRedo 

Project state changed because of undo or redo; undo manager contents did not change other than the pointer to current state

Reset 

Project state changed other than for single-step undo/redo; undo manager contents did not change other than the pointer to current state

Purge 

Undo or redo states eliminated.

BeginPurge 

Begin elimination of old undo states.

EndPurge 

End elimination of old undo states.

Definition at line 62 of file UndoManager.h.

62 {
63 Pushed,
65 Modified,
67 Renamed,
72 Reset,
75 Purge,
76
77 // Eagerly sent messages (not waiting for idle time)
79 EndPurge,
80 } type;
@ EndPurge
End elimination of old undo states.
Definition: UndoManager.h:79
@ Purge
Undo or redo states eliminated.
Definition: UndoManager.h:75
@ BeginPurge
Begin elimination of old undo states.
Definition: UndoManager.h:78
enum UndoRedoMessage::Type type

Member Data Documentation

◆ begin

const size_t UndoRedoMessage::begin = 0

Only significant for BeginPurge messages.

Definition at line 83 of file UndoManager.h.

◆ end

const size_t UndoRedoMessage::end = 0

Definition at line 83 of file UndoManager.h.

◆ type

enum UndoRedoMessage::Type UndoRedoMessage::type

The documentation for this struct was generated from the following file: