KIO::JobUiDelegate

#include <KIO/JobUiDelegate>

Inheritance diagram for KIO::JobUiDelegate:

Public Member Functions
	JobUiDelegate ()

	JobUiDelegate (KJobUiDelegate::Flags flags, QWidget *window)

	~JobUiDelegate () override

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 &title, const QString &primaryActionText, const QString &secondaryActionText, const QString &primaryActionIconName=QString(), const QString &secondaryActionIconName=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

QWidget *	window () const

Static Public Member Functions
static void	unregisterWindow (QWidget *window)

Protected Types
enum	Version { V2 }

Protected Member Functions
	JobUiDelegate (Version version, KJobUiDelegate::Flags flags=AutoHandlingDisabled, QWidget window=nullptr, const QList< QObject > &ifaces={})

Protected Member Functions inherited from KIO::JobUiDelegateExtension
	JobUiDelegateExtension ()

virtual	~JobUiDelegateExtension ()

Related Functions
(Note that these are not member functions.)
RenameDialog_Result	askFileRename (KJob *job, const QString &title, 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 KIO::JobUiDelegateExtension
enum	ClipboardUpdaterMode { UpdateContent, OverwriteContent, RemoveContent }

enum	ConfirmationType { DefaultConfirmation, ForceConfirmation }

enum	DeletionType { Delete, Trash, EmptyTrash }

enum	MessageBoxType { QuestionTwoActions = 1, WarningTwoActions = 2, WarningContinueCancel = 3, WarningTwoActionsCancel = 4, Information = 5, SSLMessageBox = 6, WarningContinueCancelDetailed = 10, QuestionYesNo = QuestionTwoActions, WarningYesNo = WarningTwoActions, WarningYesNoCancel = WarningTwoActionsCancel }

Detailed Description

A UI delegate tuned to be used with KIO Jobs.

Definition at line 39 of file jobuidelegate.h.

Constructor & Destructor Documentation

◆ JobUiDelegate() [1/3]

KIO::JobUiDelegate::JobUiDelegate ( )

Constructs a new KIO Job UI delegate.

Deprecated:: Since 5.98, use KIO::createDefaultJobUiDelegate or versioned constructor instead

Definition at line 79 of file jobuidelegate.cpp.

◆ JobUiDelegate() [2/3]

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

explicit

Constructs a new KIO Job UI Delegate.

Parameters

flags	allows to enable automatic error/warning handling
window	the window associated with this delegate, see setWindow.

Since: 5.70,

Deprecated:: Since 5.98, use KIO::createDefaultJobUiDelegate or versioned constructor instead

Definition at line 161 of file jobuidelegate.cpp.

◆ JobUiDelegate() [3/3]

KIO::JobUiDelegate::JobUiDelegate	(	Version	version,
		KJobUiDelegate::Flags	flags = `AutoHandlingDisabled`,
		QWidget *	window = `nullptr`,
		const QList< QObject * > &	ifaces = `{}`
	)

explicitprotected

Constructs a new KIO Job UI delegate.

Parameters

version	does nothing purely here to disambiguate this constructor from the deprecated older constructors.
flags	allows to enable automatic error/warning handling
window	the window associated with this delegate, see setWindow.
ifaces	Interface instances such as OpenWithHandlerInterface to replace the default interfaces

Since: 5.98

Definition at line 498 of file jobuidelegate.cpp.

◆ ~JobUiDelegate()

KIO::JobUiDelegate::~JobUiDelegate ( )

overridedefault

Destroys the KIO Job UI delegate.

Member Function Documentation

◆ askDeleteConfirmation()

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

urls	the urls about to be deleted/trashed
deletionType	the type of deletion (Delete for real deletion, Trash otherwise)
confirmation	see 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 229 of file jobuidelegate.cpp.

◆ askSkip()

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 221 of file jobuidelegate.cpp.

◆ createClipboardUpdater()

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

overridevirtual

Creates a clipboard updater.

Reimplemented from KIO::JobUiDelegateExtension.

Definition at line 483 of file jobuidelegate.cpp.

◆ requestMessageBox()

int KIO::JobUiDelegate::requestMessageBox	(	MessageBoxType	type,
		const QString &	text,
		const QString &	title,
		const QString &	primaryActionText,
		const QString &	secondaryActionText,
		const QString &	primaryActionIconName = `QString()`,
		const QString &	secondaryActionIconName = `QString()`,
		const QString &	dontAskAgainName = `QString()`,
		const KIO::MetaData &	metaData = `KIO::MetaData()`
	)

overridevirtual

This function allows for the delegation user prompts from the KIO workers.

Parameters

type	the desired type of message box.
text	the message shown to the user.
title	the title of the message dialog box.
primaryActionText	the text for the primary action button.
secondaryActionText	the text for the secondary action button.
primaryActionIconName	the icon shown on the primary action button.
secondaryActionIconName	the icon shown on the secondary action button.
dontAskAgainName	the name used to store result from 'Do not ask again' checkbox.
metaData	SSL 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 355 of file jobuidelegate.cpp.

◆ setWindow()

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

overridevirtual

Associate this job with a window given by window.

Parameters

window the window to associate to

See also: window()

Reimplemented from KDialogJobUiDelegate.

Definition at line 168 of file jobuidelegate.cpp.

◆ unregisterWindow()

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 188 of file jobuidelegate.cpp.

◆ updateUrlInClipboard()

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

overridevirtual

Update URL in clipboard, if present.

Reimplemented from KIO::JobUiDelegateExtension.

Definition at line 491 of file jobuidelegate.cpp.

Friends And Related Function Documentation

◆ askFileRename()

KIO::RenameDialog_Result KIO::JobUiDelegate::askFileRename	(	KJob *	job,
		const QString &	title,
		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()`
	)

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

title	the title for the dialog box
src	the URL of the file/dir we're trying to copy, as it's part of the text message
dest	the URL of the destination file/dir, i.e. the one that already exists
options	parameters for the dialog (which buttons to show...)
newDestPath	the new destination path, valid if R_RENAME was returned.
sizeSrc	size of source file
sizeDest	size of destination file
ctimeSrc	creation time of source file
ctimeDest	creation time of destination file
mtimeSrc	modification time of source file
mtimeDest	modification time of destination file

Returns: the result

Implements KIO::JobUiDelegateExtension.

Definition at line 193 of file jobuidelegate.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KIO

KIO::JobUiDelegate

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JobUiDelegate() [1/3]

◆ JobUiDelegate() [2/3]

◆ JobUiDelegate() [3/3]

◆ ~JobUiDelegate()

Member Function Documentation

◆ askDeleteConfirmation()

◆ askSkip()

◆ createClipboardUpdater()

◆ requestMessageBox()

◆ setWindow()

◆ unregisterWindow()

◆ updateUrlInClipboard()

Friends And Related Function Documentation

◆ askFileRename()