KIO::FileUndoManager
#include <KIO/FileUndoManager>
Classes | |
class | UiInterface |
Public Types | |
enum | CommandType { Copy , Move , Rename , Link , Mkdir , Trash , Put , Mkpath , BatchRename } |
Public Types inherited from QObject | |
typedef | QObjectList |
Signals | |
void | jobRecordingFinished (FileUndoManager::CommandType op) |
void | jobRecordingStarted (CommandType op) |
void | undoAvailable (bool avail) |
void | undoJobFinished () |
void | undoTextChanged (const QString &text) |
Public Slots | |
void | undo () |
Public Member Functions | |
quint64 | currentCommandSerialNumber () const |
bool | isUndoAvailable () const |
quint64 | newCommandSerialNumber () |
void | recordCopyJob (KIO::CopyJob *copyJob) |
void | recordJob (CommandType op, const QList< QUrl > &src, const QUrl &dst, KIO::Job *job) |
void | setUiInterface (UiInterface *ui) |
UiInterface * | uiInterface () const |
QString | undoText () const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () 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 () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
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 | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Static Public Member Functions | |
static FileUndoManager * | self () |
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 *context, Functor functor, 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) |
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Additional Inherited Members | |
Properties inherited from QObject | |
objectName | |
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 |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
FileUndoManager: makes it possible to undo kio jobs.
This class is a singleton, use self() to access its only instance.
Member Enumeration Documentation
◆ CommandType
The type of job.
Enumerator | |
---|---|
Put | Represents the creation of a file from data in memory. Used when pasting data from clipboard or drag-n-drop.
|
Mkpath | Represents a KIO::mkpath() job.
|
BatchRename | Represents a KIO::batchRename() job. Used when renaming multiple files.
|
Definition at line 123 of file fileundomanager.h.
Member Function Documentation
◆ currentCommandSerialNumber()
quint64 FileUndoManager::currentCommandSerialNumber | ( | ) | const |
Definition at line 338 of file fileundomanager.cpp.
◆ isUndoAvailable()
bool FileUndoManager::isUndoAvailable | ( | ) | const |
- Returns
- true if undo is possible. Usually used for enabling/disabling the undo action.
- Since
- 5.79
Definition at line 297 of file fileundomanager.cpp.
◆ jobRecordingFinished
|
signal |
Emitted when a job that has been recorded by FileUndoManager::recordJob() or FileUndoManager::recordCopyJob has been finished.
The command is now available for an undo-operation.
◆ jobRecordingStarted
|
signal |
Emitted when a job recording has been started by FileUndoManager::recordJob() or FileUndoManager::recordCopyJob().
After the job recording has been finished, the signal jobRecordingFinished() will be emitted.
◆ newCommandSerialNumber()
quint64 FileUndoManager::newCommandSerialNumber | ( | ) |
These two functions are useful when wrapping FileUndoManager and adding custom commands.
Each command has a unique ID. You can get a new serial number for a custom command with newCommandSerialNumber(), and then when you want to undo, check if the command FileUndoManager would undo is newer or older than your custom command.
Definition at line 333 of file fileundomanager.cpp.
◆ recordCopyJob()
void FileUndoManager::recordCopyJob | ( | KIO::CopyJob * | copyJob | ) |
Record this CopyJob while it's happening and add a command for it so that the user can undo it.
The signal jobRecordingStarted() is emitted.
Definition at line 272 of file fileundomanager.cpp.
◆ recordJob()
void FileUndoManager::recordJob | ( | CommandType | op, |
const QList< QUrl > & | src, | ||
const QUrl & | dst, | ||
KIO::Job * | job ) |
Record this job while it's happening and add a command for it so that the user can undo it.
The signal jobRecordingStarted() is emitted.
- Parameters
-
op the type of job - which is also the type of command that will be created for it src list of source urls. This is empty for Mkdir, Mkpath, Put operations. dst destination url job the job to record
Definition at line 265 of file fileundomanager.cpp.
◆ self()
|
static |
- Returns
- the FileUndoManager instance
Definition at line 230 of file fileundomanager.cpp.
◆ setUiInterface()
void FileUndoManager::setUiInterface | ( | UiInterface * | ui | ) |
Set a new UiInterface implementation.
This deletes the previous one.
- Parameters
-
ui the UiInterface instance, which becomes owned by the undo manager.
Definition at line 691 of file fileundomanager.cpp.
◆ uiInterface()
FileUndoManager::UiInterface * FileUndoManager::uiInterface | ( | ) | const |
- Returns
- the UiInterface instance passed to setUiInterface. This is useful for calling setParentWidget on it. Never delete it!
Definition at line 696 of file fileundomanager.cpp.
◆ undo
|
slot |
Undoes the last command Remember to call uiInterface()->setParentWidget(parentWidget) first, if you have multiple mainwindows.
This operation is asynchronous. undoJobFinished will be emitted once the undo is complete.
Definition at line 349 of file fileundomanager.cpp.
◆ undoAvailable
|
signal |
Emitted when the value of isUndoAvailable() changes.
◆ undoJobFinished
|
signal |
Emitted when an undo job finishes. Used for unit testing.
◆ undoText()
QString FileUndoManager::undoText | ( | ) | const |
- Returns
- the current text for the undo action.
Definition at line 302 of file fileundomanager.cpp.
◆ undoTextChanged
|
signal |
Emitted when the value of undoText() changes.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:33:15 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.