Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
Medical Imaging Interaction Toolkit
mitk::VerboseLimitedLinearUndo Class Reference

A limited linear undo model providing GUI elements with stack status information. More...

#include <mitkVerboseLimitedLinearUndo.h>

Inheritance diagram for mitk::VerboseLimitedLinearUndo:
Collaboration diagram for mitk::VerboseLimitedLinearUndo:

Public Types

typedef VerboseLimitedLinearUndo Self
 
typedef LimitedLinearUndo Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef std::pair< int, std::string > StackDescriptionItem
 
typedef std::vector< StackDescriptionItemStackDescription
 
- Public Types inherited from mitk::LimitedLinearUndo
typedef std::deque< UndoStackItem * > UndoContainer
 
typedef std::deque< UndoStackItem * >::reverse_iterator UndoContainerRevIter
 
typedef LimitedLinearUndo Self
 
typedef UndoModel Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::UndoModel
typedef UndoModel Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
bool SetOperationEvent (UndoStackItem *undoStackItem) override
 a list of pairs (int,string), representing a stack with ObjectEventIDs and descriptions More...
 
virtual StackDescription GetUndoDescriptions ()
 
virtual StackDescription GetRedoDescriptions ()
 
- Public Member Functions inherited from mitk::LimitedLinearUndo
Pointer Clone () const
 
bool Undo () override
 Undoes the last changes. More...
 
bool Undo (bool) override
 
virtual bool Undo (int oeid)
 Undoes all changes until ObjectEventID oeid. More...
 
bool Redo () override
 Undoes the last changes. More...
 
bool Redo (bool) override
 
virtual bool Redo (int oeid)
 Redoes all changes until ObjectEventID oeid. More...
 
void Clear () override
 Clears UndoList and RedoList. More...
 
void ClearRedoList () override
 Clears the RedoList. More...
 
bool RedoListEmpty () override
 True, if RedoList is empty. More...
 
std::vcl_size_t GetUndoLimit () const override
 Gets the limit on the size of the undo history. The undo limit determines how many items can be stored in the undo stack. If the value is 0 that means that there is no limit. More...
 
void SetUndoLimit (std::vcl_size_t limit) override
 Sets a limit on the size of the undo history. If the limit is reached, the oldest undo items will be dropped from the bottom of the undo stack. The 0 value means that there is no limit. More...
 
int GetLastObjectEventIdInList () override
 Returns the ObjectEventId of the top element in the OperationHistory. More...
 
int GetLastGroupEventIdInList () override
 Returns the GroupEventId of the top element in the OperationHistory. More...
 
OperationEventGetLastOfType (OperationActor *destination, OperationType opType) override
 Returns the last specified OperationEvent in Undo-list corresponding to the given values; if nothing found, then returns nullptr. More...
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::LimitedLinearUndo
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::UndoModel
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 VerboseLimitedLinearUndo ()
 
 ~VerboseLimitedLinearUndo () override
 
- Protected Member Functions inherited from mitk::LimitedLinearUndo
 LimitedLinearUndo ()
 
 ~LimitedLinearUndo () override
 
void ClearList (UndoContainer *list)
 
- Protected Member Functions inherited from mitk::UndoModel
 UndoModel ()
 
 ~UndoModel () override
 

Additional Inherited Members

- Protected Attributes inherited from mitk::LimitedLinearUndo
UndoContainer m_UndoList
 
UndoContainer m_RedoList
 

Detailed Description

A limited linear undo model providing GUI elements with stack status information.

Basically does the same, as LimitedLinearUndo class, but it allows you to retrieve a string list, which describes the undo stack or the redo stack. This can be used for display by GUI elements.

Definition at line 35 of file mitkVerboseLimitedLinearUndo.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ StackDescription

◆ StackDescriptionItem

typedef std::pair<int, std::string> mitk::VerboseLimitedLinearUndo::StackDescriptionItem

Definition at line 40 of file mitkVerboseLimitedLinearUndo.h.

◆ Superclass

Constructor & Destructor Documentation

◆ VerboseLimitedLinearUndo()

mitk::VerboseLimitedLinearUndo::VerboseLimitedLinearUndo ( )
protected

◆ ~VerboseLimitedLinearUndo()

mitk::VerboseLimitedLinearUndo::~VerboseLimitedLinearUndo ( )
overrideprotected

Member Function Documentation

◆ Clone()

Pointer mitk::VerboseLimitedLinearUndo::Clone ( ) const

◆ GetClassHierarchy()

virtual std::vector<std::string> mitk::VerboseLimitedLinearUndo::GetClassHierarchy ( ) const
inlineoverridevirtual

Reimplemented from mitk::LimitedLinearUndo.

Definition at line 38 of file mitkVerboseLimitedLinearUndo.h.

◆ GetClassName()

virtual const char* mitk::VerboseLimitedLinearUndo::GetClassName ( ) const
virtual

Reimplemented from mitk::LimitedLinearUndo.

◆ GetRedoDescriptions()

virtual StackDescription mitk::VerboseLimitedLinearUndo::GetRedoDescriptions ( )
virtual

◆ GetStaticNameOfClass()

static const char* mitk::VerboseLimitedLinearUndo::GetStaticNameOfClass ( )
inlinestatic

Definition at line 38 of file mitkVerboseLimitedLinearUndo.h.

◆ GetUndoDescriptions()

virtual StackDescription mitk::VerboseLimitedLinearUndo::GetUndoDescriptions ( )
virtual

◆ New()

static Pointer mitk::VerboseLimitedLinearUndo::New ( )
static

◆ SetOperationEvent()

bool mitk::VerboseLimitedLinearUndo::SetOperationEvent ( UndoStackItem undoStackItem)
overridevirtual

a list of pairs (int,string), representing a stack with ObjectEventIDs and descriptions

Reimplemented from mitk::LimitedLinearUndo.


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