KateUndo Class Reference

#include <kateundo.h>

Inheritance diagram for KateUndo:

Public Types
enum	ModificationFlag {   UndoLine1Modified = 1, UndoLine2Modified = 2, UndoLine1Saved = 4, UndoLine2Saved = 8,   RedoLine1Modified = 16, RedoLine2Modified = 32, RedoLine1Saved = 64, RedoLine2Saved = 128 }
enum	UndoType {   editInsertText, editRemoveText, editWrapLine, editUnWrapLine,   editInsertLine, editRemoveLine, editMarkLineAutoWrapped, editInvalid }

Public Member Functions
	KateUndo (KateDocument *document)
virtual	~KateUndo ()
virtual bool	isEmpty () const
bool	isFlagSet (ModificationFlag flag) const
virtual bool	mergeWith (const KateUndo *undo)
virtual void	redo ()=0
void	setFlag (ModificationFlag flag)
virtual KateUndo::UndoType	type () const =0
virtual void	undo ()=0
void	unsetFlag (ModificationFlag flag)
virtual void	updateRedoSavedOnDiskFlag (QBitArray &lines)
virtual void	updateUndoSavedOnDiskFlag (QBitArray &lines)

Protected Member Functions
KateDocument *	document ()

Detailed Description

Base class for Kate undo commands.

Definition at line 41 of file kateundo.h.

Member Enumeration Documentation

enum KateUndo::ModificationFlag

Enumerator
UndoLine1Modified
UndoLine2Modified
UndoLine1Saved
UndoLine2Saved
RedoLine1Modified
RedoLine2Modified
RedoLine1Saved
RedoLine2Saved

Definition at line 120 of file kateundo.h.

enum KateUndo::UndoType

Types for undo items.

Enumerator
editInsertText
editRemoveText
editWrapLine
editUnWrapLine
editInsertLine
editRemoveLine
editMarkLineAutoWrapped
editInvalid

Definition at line 59 of file kateundo.h.

Constructor & Destructor Documentation

KateUndo::KateUndo

(

KateDocument *

document

)

Constructor.

Parameters

document

the document the undo item belongs to

Definition at line 31 of file kateundo.cpp.

KateUndo::~KateUndo ( )

virtual

Destructor.

Definition at line 37 of file kateundo.cpp.

Member Function Documentation

KateDocument* KateUndo::document ( )

inlineprotected

Return the document the undo item belongs to.

Returns

the document the undo item belongs to

Definition at line 108 of file kateundo.h.

bool KateUndo::isEmpty ( ) const

virtual

Check whether the item is empty.

Returns

whether the item is empty

Reimplemented in KateEditRemoveTextUndo, and KateEditInsertTextUndo.

Definition at line 90 of file kateundo.cpp.

bool KateUndo::isFlagSet ( ModificationFlag  flag ) const

inline

Definition at line 139 of file kateundo.h.

bool KateUndo::mergeWith ( const KateUndo *  undo )

virtual

merge an undo item Saves a bit of memory and potentially many calls when undo/redoing.

Parameters

undo	undo item to merge

Returns

success

Reimplemented in KateEditRemoveTextUndo, and KateEditInsertTextUndo.

Definition at line 105 of file kateundo.cpp.

virtual void KateUndo::redo ( )

pure virtual

redo this item

Implemented in KateEditRemoveLineUndo, KateEditInsertLineUndo, KateEditUnWrapLineUndo, KateEditWrapLineUndo, KateEditMarkLineAutoWrappedUndo, KateEditRemoveTextUndo, KateEditInsertTextUndo, KateModifiedRemoveLine, KateModifiedInsertLine, KateModifiedUnWrapLine, KateModifiedWrapLine, KateModifiedRemoveText, and KateModifiedInsertText.

void KateUndo::setFlag ( ModificationFlag  flag )

inline

Definition at line 131 of file kateundo.h.

virtual KateUndo::UndoType KateUndo::type ( ) const

pure virtual

type of item

Returns

type

Implemented in KateEditRemoveLineUndo, KateEditInsertLineUndo, KateEditUnWrapLineUndo, KateEditWrapLineUndo, KateEditMarkLineAutoWrappedUndo, KateEditRemoveTextUndo, and KateEditInsertTextUndo.

virtual void KateUndo::undo ( )

pure virtual

undo this item

Implemented in KateEditRemoveLineUndo, KateEditInsertLineUndo, KateEditUnWrapLineUndo, KateEditWrapLineUndo, KateEditMarkLineAutoWrappedUndo, KateEditRemoveTextUndo, KateEditInsertTextUndo, KateModifiedRemoveLine, KateModifiedInsertLine, KateModifiedUnWrapLine, KateModifiedWrapLine, KateModifiedRemoveText, and KateModifiedInsertText.

void KateUndo::unsetFlag ( ModificationFlag  flag )

inline

Definition at line 135 of file kateundo.h.

virtual void KateUndo::updateRedoSavedOnDiskFlag ( QBitArray &  lines )

inlinevirtual

Reimplemented in KateModifiedInsertLine, KateModifiedUnWrapLine, KateModifiedWrapLine, KateModifiedRemoveText, and KateModifiedInsertText.

Definition at line 144 of file kateundo.h.

virtual void KateUndo::updateUndoSavedOnDiskFlag ( QBitArray &  lines )

inlinevirtual

Reimplemented in KateModifiedRemoveLine, KateModifiedUnWrapLine, KateModifiedWrapLine, KateModifiedRemoveText, and KateModifiedInsertText.

Definition at line 143 of file kateundo.h.

---

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

• kateundo.h
• kateundo.cpp