KateUndoManager

KateUndoManager Class Reference

#include <kateundomanager.h>

Inheritance diagram for KateUndoManager:

Signals

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

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 ()
 

Public Member Functions

 KateUndoManager (KTextEditor::DocumentPrivate *doc)
 
KTextEditor::Documentdocument ()
 
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 ()
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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 51 of file kateundomanager.h.

Constructor & Destructor Documentation

KateUndoManager::KateUndoManager ( KTextEditor::DocumentPrivate *  doc)
explicit

Creates a clean undo history.

Parameters
docthe document the KateUndoManager will belong to

Definition at line 31 of file kateundomanager.cpp.

Member Function Documentation

void KateUndoManager::editEnd ( )
slot

Notify KateUndoManager about the end of an edit.

Definition at line 80 of file kateundomanager.cpp.

void KateUndoManager::editStart ( )
slot

Notify KateUndoManager about the beginning of an edit.

Definition at line 62 of file kateundomanager.cpp.

KTextEditor::Cursor KateUndoManager::lastRedoCursor ( ) const

Returns the redo cursor of the last undo group.

Needed for the swap file recovery.

Definition at line 426 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 260 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 239 of file kateundomanager.cpp.

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
allowwhether complex merging is allowed

Definition at line 441 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
undoCursorthe undo cursor
redoCursorthe redo cursor

Definition at line 416 of file kateundomanager.cpp.

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

Notify KateUndoManager that a line was inserted.

Definition at line 173 of file kateundomanager.cpp.

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

Notify KateUndoManager that a line was removed.

Definition at line 180 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 166 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 159 of file kateundomanager.cpp.

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

Notify KateUndoManager that a line was marked as autowrapped.

Definition at line 152 of file kateundomanager.cpp.

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

Notify KateUndoManager that text was inserted.

Definition at line 138 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::undo ( )
slot

Undo the latest undo group.

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

Definition at line 244 of file kateundomanager.cpp.

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 234 of file kateundomanager.cpp.

void KateUndoManager::undoSafePoint ( )

Prevent latest KateUndoGroup from being merged with the next one.

Definition at line 197 of file kateundomanager.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Jul 4 2020 22:58:06 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.