KIO::JobUiDelegate

#include <KIO/JobUiDelegate>

Inheritance diagram for KIO::JobUiDelegate:

Public Member Functions

 JobUiDelegate ()
 
 JobUiDelegate (KJobUiDelegate::Flags flags, QWidget *window)
 
virtual ~JobUiDelegate ()
 
bool askDeleteConfirmation (const QList< QUrl > &urls, DeletionType deletionType, ConfirmationType confirmationType) override
 
SkipDialog_Result askSkip (KJob *job, KIO::SkipDialog_Options options, const QString &error_text) override
 
ClipboardUpdater * createClipboardUpdater (Job *job, ClipboardUpdaterMode mode) override
 
int requestMessageBox (MessageBoxType type, const QString &text, const QString &caption, const QString &buttonYes, const QString &buttonNo, const QString &iconYes=QString(), const QString &iconNo=QString(), const QString &dontAskAgainName=QString(), const KIO::MetaData &metaData=KIO::MetaData()) override
 
void setWindow (QWidget *window) override
 
void updateUrlInClipboard (const QUrl &src, const QUrl &dest) override
 
- Public Member Functions inherited from KDialogJobUiDelegate
 KDialogJobUiDelegate (KJobUiDelegate::Flags flags, QWidget *window)
 
bool setJob (KJob *job) override
 
void updateUserTimestamp (unsigned long time)
 
unsigned long userTimestamp () const
 
QWidgetwindow () const
 
- Public Member Functions inherited from KJobUiDelegate
 KJobUiDelegate (Flags flags)
 
bool isAutoErrorHandlingEnabled () const
 
bool isAutoWarningHandlingEnabled () const
 
void setAutoErrorHandlingEnabled (bool enable)
 
void setAutoWarningHandlingEnabled (bool enable)
 
virtual void showErrorMessage ()
 
- 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
 

Static Public Member Functions

static void unregisterWindow (QWidget *window)
 
- 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)
 

Related Functions

(Note that these are not member functions.)

RenameDialog_Result askFileRename (KJob *job, const QString &caption, const QUrl &src, const QUrl &dest, KIO::RenameDialog_Options options, QString &newDest, KIO::filesize_t sizeSrc=KIO::filesize_t(-1), KIO::filesize_t sizeDest=KIO::filesize_t(-1), const QDateTime &ctimeSrc=QDateTime(), const QDateTime &ctimeDest=QDateTime(), const QDateTime &mtimeSrc=QDateTime(), const QDateTime &mtimeDest=QDateTime()) override
 

Additional Inherited Members

- Public Types inherited from KJobUiDelegate
enum  Flag
 
typedef QFlags< FlagFlags
 
- Public Types inherited from KIO::JobUiDelegateExtension
enum  ClipboardUpdaterMode { UpdateContent, OverwriteContent, RemoveContent }
 
enum  ConfirmationType { DefaultConfirmation, ForceConfirmation }
 
enum  DeletionType { Delete, Trash, EmptyTrash }
 
enum  MessageBoxType {
  QuestionYesNo = 1, WarningYesNo = 2, WarningContinueCancel = 3, WarningYesNoCancel = 4,
  Information = 5, SSLMessageBox = 6, WarningContinueCancelDetailed = 10
}
 
- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from KJobUiDelegate
 AutoErrorHandlingEnabled
 
 AutoHandlingDisabled
 
 AutoHandlingEnabled
 
 AutoWarningHandlingEnabled
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from KJobUiDelegate
KJobjob () const
 
- 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)
 
- Protected Member Functions inherited from KIO::JobUiDelegateExtension
 JobUiDelegateExtension ()
 
virtual ~JobUiDelegateExtension ()
 

Detailed Description

A UI delegate tuned to be used with KIO Jobs.

Definition at line 42 of file jobuidelegate.h.

Constructor & Destructor Documentation

KIO::JobUiDelegate::JobUiDelegate ( )

Constructs a new KIO Job UI delegate.

Definition at line 59 of file jobuidelegate.cpp.

KIO::JobUiDelegate::JobUiDelegate ( KJobUiDelegate::Flags  flags,
QWidget window 
)
explicit

Constructs a new KIO Job UI Delegate.

Parameters
flagsallows to enable automatic error/warning handling
windowthe window associated with this delegate, see setWindow.
Since
5.70

Definition at line 144 of file jobuidelegate.cpp.

KIO::JobUiDelegate::~JobUiDelegate ( )
virtual

Destroys the KIO Job UI delegate.

Definition at line 69 of file jobuidelegate.cpp.

Member Function Documentation

bool KIO::JobUiDelegate::askDeleteConfirmation ( const QList< QUrl > &  urls,
DeletionType  deletionType,
ConfirmationType  confirmationType 
)
overridevirtual

Ask for confirmation before deleting/trashing urls.

Note that this method is not called automatically by KIO jobs. It's the application's responsibility to ask the user for confirmation before calling KIO::del() or KIO::trash().

Parameters
urlsthe urls about to be deleted/trashed
deletionTypethe type of deletion (Delete for real deletion, Trash otherwise)
confirmationsee ConfirmationType. Normally set to DefaultConfirmation. Note: the window passed to setWindow is used as the parent for the message box.
Returns
true if confirmed

Implements KIO::JobUiDelegateExtension.

Definition at line 202 of file jobuidelegate.cpp.

KIO::SkipDialog_Result KIO::JobUiDelegate::askSkip ( KJob job,
KIO::SkipDialog_Options  options,
const QString error_text 
)
overridevirtual

See skipdialog.h

Implements KIO::JobUiDelegateExtension.

Definition at line 192 of file jobuidelegate.cpp.

KIO::ClipboardUpdater * KIO::JobUiDelegate::createClipboardUpdater ( Job job,
ClipboardUpdaterMode  mode 
)
overridevirtual

Creates a clipboard updater.

Reimplemented from KIO::JobUiDelegateExtension.

Definition at line 417 of file jobuidelegate.cpp.

int KIO::JobUiDelegate::requestMessageBox ( MessageBoxType  type,
const QString text,
const QString caption,
const QString buttonYes,
const QString buttonNo,
const QString iconYes = QString(),
const QString iconNo = QString(),
const QString dontAskAgainName = QString(),
const KIO::MetaData metaData = KIO::MetaData() 
)
overridevirtual

This function allows for the delegation user prompts from the ioslaves.

Parameters
typethe desired type of message box.
textthe message shown to the user.
captionthe caption of the message dialog box.
buttonYesthe text for the YES button.
buttonNothe text for the NO button.
iconYesthe icon shown on the YES button.
iconNothe icon shown on the NO button.
dontAskAgainNamethe name used to store result from 'Do not ask again' checkbox.
metaDataSSL information used by the SSLMessageBox. Since 5.66 this is also used for privilege operation details.
Since
4.11

Implements KIO::JobUiDelegateExtension.

Definition at line 318 of file jobuidelegate.cpp.

void KIO::JobUiDelegate::setWindow ( QWidget window)
overridevirtual

Associate this job with a window given by window.

Parameters
windowthe window to associate to
See also
window()

Reimplemented from KDialogJobUiDelegate.

Definition at line 150 of file jobuidelegate.cpp.

void KIO::JobUiDelegate::unregisterWindow ( QWidget window)
static

Unregister the given window from kded.

This is normally done automatically when the window is destroyed.

This method is useful for instance when keeping a hidden window around to make it faster to reuse later.

Since
5.2

Definition at line 156 of file jobuidelegate.cpp.

void KIO::JobUiDelegate::updateUrlInClipboard ( const QUrl src,
const QUrl dest 
)
overridevirtual

Update URL in clipboard, if present.

Reimplemented from KIO::JobUiDelegateExtension.

Definition at line 425 of file jobuidelegate.cpp.

Friends And Related Function Documentation

KIO::RenameDialog_Result KIO::JobUiDelegate::askFileRename ( KJob job,
const QString caption,
const QUrl src,
const QUrl dest,
KIO::RenameDialog_Options  options,
QString newDest,
KIO::filesize_t  sizeSrc = KIO::filesize_t(-1),
KIO::filesize_t  sizeDest = KIO::filesize_t(-1),
const QDateTime ctimeSrc = QDateTime(),
const QDateTime ctimeDest = QDateTime(),
const QDateTime mtimeSrc = QDateTime(),
const QDateTime mtimeDest = QDateTime() 
)
related

Construct a modal, parent-less "rename" dialog, and return a result code, as well as the new dest. Much easier to use than the class RenameDialog directly.

Parameters
captionthe caption for the dialog box
srcthe URL of the file/dir we're trying to copy, as it's part of the text message
destthe URL of the destination file/dir, i.e. the one that already exists
optionsparameters for the dialog (which buttons to show...)
newDestPaththe new destination path, valid if R_RENAME was returned.
sizeSrcsize of source file
sizeDestsize of destination file
ctimeSrccreation time of source file
ctimeDestcreation time of destination file
mtimeSrcmodification time of source file
mtimeDestmodification time of destination file
Returns
the result

Implements KIO::JobUiDelegateExtension.

Definition at line 161 of file jobuidelegate.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 Tue Jul 14 2020 23:01:04 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.