KateUndoManager Class Reference

#include <kateundomanager.h>

Inheritance diagram for KateUndoManager:

Public Slots
void	clearRedo ()
void	clearUndo ()
void	editEnd ()
void	editStart ()
void	endUndo ()
void	inputMethodEnd ()
void	inputMethodStart ()
void	redo ()
void	slotLineInserted (int line, const QString &s)
void	slotLineRemoved (int line, const QString &s)
void	slotLineUnWrapped (int line, int col, int length, bool lineRemoved)
void	slotLineWrapped (int line, int col, int length, bool newLine)
void	slotMarkLineAutoWrapped (int line, bool autowrapped)
void	slotTextInserted (int line, int col, const QString &s)
void	slotTextRemoved (int line, int col, const QString &s)
void	startUndo ()
void	undo ()

Signals
void	isActiveChanged (bool enabled)
void	redoEnd (KTextEditor::Document *)
void	redoStart (KTextEditor::Document *)
void	undoChanged ()
void	undoEnd (KTextEditor::Document *)
void	undoStart (KTextEditor::Document *)

Public Member Functions
	KateUndoManager (KateDocument *doc)
	~KateUndoManager ()
KTextEditor::Document *	document ()
bool	isActive () const
KTextEditor::Cursor	lastRedoCursor () const
uint	redoCount () const
void	setAllowComplexMerge (bool allow)
void	setModified (bool modified)
void	setUndoRedoCursorsOfLastGroup (const KTextEditor::Cursor undoCursor, const KTextEditor::Cursor redoCursor)
uint	undoCount () const
void	undoSafePoint ()
void	updateConfig ()
void	updateLineModifications ()

Detailed Description

KateUndoManager implements a document's history.

It is in either of the two states:

• the default state, which allows rolling back and forth the history of a document, and
• a state in which a new element is being added to the history.

The state of the KateUndomanager can be switched using editStart() and editEnd().

Definition at line 45 of file kateundomanager.h.

Constructor & Destructor Documentation

KateUndoManager::KateUndoManager

(

KateDocument *

doc

)

Creates a clean undo history.

Parameters

doc	the document the KateUndoManager will belong to

Definition at line 27 of file kateundomanager.cpp.

KateUndoManager::~KateUndoManager

(

)

Definition at line 44 of file kateundomanager.cpp.

Member Function Documentation

void KateUndoManager::clearRedo ( )

slot

Definition at line 354 of file kateundomanager.cpp.

void KateUndoManager::clearUndo ( )

slot

Definition at line 343 of file kateundomanager.cpp.

KTextEditor::Document * KateUndoManager::document

(

)

Definition at line 55 of file kateundomanager.cpp.

void KateUndoManager::editEnd ( )

slot

Notify KateUndoManager about the end of an edit.

Definition at line 82 of file kateundomanager.cpp.

void KateUndoManager::editStart ( )

slot

Notify KateUndoManager about the beginning of an edit.

Definition at line 65 of file kateundomanager.cpp.

void KateUndoManager::endUndo ( )

slot

Definition at line 133 of file kateundomanager.cpp.

void KateUndoManager::inputMethodEnd ( )

slot

Definition at line 121 of file kateundomanager.cpp.

void KateUndoManager::inputMethodStart ( )

slot

Definition at line 115 of file kateundomanager.cpp.

bool KateUndoManager::isActive ( ) const

inline

Definition at line 90 of file kateundomanager.h.

void KateUndoManager::isActiveChanged ( bool  enabled )

signal

KTextEditor::Cursor KateUndoManager::lastRedoCursor

(

)

const

Returns the redo cursor of the last undo group.

Needed for the swap file recovery.

Definition at line 414 of file kateundomanager.cpp.

void KateUndoManager::redo ( )

slot

Redo the latest undo group.

Make sure isDefaultState() is true when calling this method.

Definition at line 251 of file kateundomanager.cpp.

uint KateUndoManager::redoCount

(

)

const

Returns how many redo() actions can be performed.

Returns

the number of undo groups which can be redone

Definition at line 229 of file kateundomanager.cpp.

void KateUndoManager::redoEnd ( KTextEditor::Document *  )

signal

void KateUndoManager::redoStart ( KTextEditor::Document *  )

signal

void KateUndoManager::setAllowComplexMerge

(

bool

allow

)

Allows or disallows merging of "complex" undo groups.

When an undo group contains different types of undo items, it is considered a "complex" group.

Parameters

allow

whether complex merging is allowed

Definition at line 429 of file kateundomanager.cpp.

void KateUndoManager::setModified

(

bool

modified

)

Definition at line 365 of file kateundomanager.cpp.

void KateUndoManager::setUndoRedoCursorsOfLastGroup	(	const KTextEditor::Cursor	undoCursor,
		const KTextEditor::Cursor	redoCursor
	)

Used by the swap file recovery, this function afterwards manipulates the undo/redo cursors of the last KateUndoGroup.

This function should not be used other than by Kate::SwapFile.

Parameters

undoCursor	the undo cursor
redoCursor	the redo cursor

Definition at line 403 of file kateundomanager.cpp.

void KateUndoManager::slotLineInserted ( int  line, const QString &  s  )

slot

Notify KateUndoManager that a line was inserted.

Definition at line 169 of file kateundomanager.cpp.

void KateUndoManager::slotLineRemoved ( int  line, const QString &  s  )

slot

Notify KateUndoManager that a line was removed.

Definition at line 175 of file kateundomanager.cpp.

void KateUndoManager::slotLineUnWrapped ( int  line, int  col, int  length, bool  lineRemoved  )

slot

Notify KateUndoManager that a line was un-wrapped.

Definition at line 163 of file kateundomanager.cpp.

void KateUndoManager::slotLineWrapped ( int  line, int  col, int  length, bool  newLine  )

slot

Notify KateUndoManager that a line was wrapped.

Definition at line 157 of file kateundomanager.cpp.

void KateUndoManager::slotMarkLineAutoWrapped ( int  line, bool  autowrapped  )

slot

Notify KateUndoManager that a line was marked as autowrapped.

Definition at line 151 of file kateundomanager.cpp.

void KateUndoManager::slotTextInserted ( int  line, int  col, const QString &  s  )

slot

Notify KateUndoManager that text was inserted.

Definition at line 139 of file kateundomanager.cpp.

void KateUndoManager::slotTextRemoved ( int  line, int  col, const QString &  s  )

slot

Notify KateUndoManager that text was removed.

Definition at line 145 of file kateundomanager.cpp.

void KateUndoManager::startUndo ( )

slot

Definition at line 127 of file kateundomanager.cpp.

void KateUndoManager::undo ( )

slot

Undo the latest undo group.

Make sure isDefaultState() is true when calling this method.

Definition at line 234 of file kateundomanager.cpp.

void KateUndoManager::undoChanged ( )

signal

uint KateUndoManager::undoCount

(

)

const

Returns how many undo() actions can be performed.

Returns

the number of undo groups which can be undone

Definition at line 224 of file kateundomanager.cpp.

void KateUndoManager::undoEnd ( KTextEditor::Document *  )

signal

void KateUndoManager::undoSafePoint

(

)

Prevent latest KateUndoGroup from being merged with the next one.

Definition at line 190 of file kateundomanager.cpp.

void KateUndoManager::undoStart ( KTextEditor::Document *  )

signal

void KateUndoManager::updateConfig

(

)

Definition at line 424 of file kateundomanager.cpp.

void KateUndoManager::updateLineModifications

(

)

Definition at line 382 of file kateundomanager.cpp.

---

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

• kateundomanager.h
• kateundomanager.cpp