• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KIO

  • KIO
  • JobUiDelegate
Public Types | Public Member Functions | Related Functions
KIO::JobUiDelegate Class Reference

#include <jobuidelegate.h>

Inheritance diagram for KIO::JobUiDelegate:
KDialogJobUiDelegate KJobUiDelegate QObject

List of all members.

Public Types

enum  ConfirmationType { DefaultConfirmation, ForceConfirmation }
enum  DeletionType { Delete, Trash, EmptyTrash }

Public Member Functions

 JobUiDelegate ()
virtual ~JobUiDelegate ()
bool askDeleteConfirmation (const KUrl::List &urls, DeletionType deletionType, ConfirmationType confirmationType)
virtual SkipDialog_Result askSkip (KJob *job, bool multi, const QString &error_text)
virtual void setWindow (QWidget *window)
- Public Member Functions inherited from KDialogJobUiDelegate
 KDialogJobUiDelegate ()
virtual ~KDialogJobUiDelegate ()
virtual void showErrorMessage ()
void updateUserTimestamp (unsigned long time)
unsigned long userTimestamp () const
QWidget * window () const
- Public Member Functions inherited from KJobUiDelegate
 KJobUiDelegate ()
virtual ~KJobUiDelegate ()
bool isAutoErrorHandlingEnabled () const
bool isAutoWarningHandlingEnabled () const
void setAutoErrorHandlingEnabled (bool enable)
void setAutoWarningHandlingEnabled (bool enable)

Related Functions

(Note that these are not member functions.)

virtual RenameDialog_Result askFileRename (KJob *job, const QString &caption, const QString &src, const QString &dest, KIO::RenameDialog_Mode mode, QString &newDest, KIO::filesize_t sizeSrc=KIO::filesize_t(-1), KIO::filesize_t sizeDest=KIO::filesize_t(-1), time_t ctimeSrc=time_t(-1), time_t ctimeDest=time_t(-1), time_t mtimeSrc=time_t(-1), time_t mtimeDest=time_t(-1))

Additional Inherited Members

- Protected Slots inherited from KDialogJobUiDelegate
virtual void slotWarning (KJob *job, const QString &plain, const QString &rich)
- Protected Slots inherited from KJobUiDelegate

Detailed Description

A UI delegate tuned to be used with KIO Jobs.

Definition at line 37 of file jobuidelegate.h.


Member Enumeration Documentation

enum KIO::JobUiDelegate::ConfirmationType

ForceConfirmation: always ask the user for confirmation DefaultConfirmation: don't ask the user if he/she said "don't ask again".

Used by askDeleteConfirmation.

Enumerator:
DefaultConfirmation 
ForceConfirmation 

Definition at line 114 of file jobuidelegate.h.

enum KIO::JobUiDelegate::DeletionType

The type of deletion: real deletion, moving the files to the trash or emptying the trash Used by askDeleteConfirmation.

Enumerator:
Delete 
Trash 
EmptyTrash 

Definition at line 107 of file jobuidelegate.h.


Constructor & Destructor Documentation

KIO::JobUiDelegate::JobUiDelegate ( )

Constructs a new KIO Job UI delegate.

Definition at line 45 of file jobuidelegate.cpp.

KIO::JobUiDelegate::~JobUiDelegate ( )
virtual

Destroys the KIO Job UI delegate.

Definition at line 50 of file jobuidelegate.cpp.


Member Function Documentation

bool KIO::JobUiDelegate::askDeleteConfirmation ( const KUrl::List &  urls,
DeletionType  deletionType,
ConfirmationType  confirmationType 
)

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
methodthe 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

Definition at line 103 of file jobuidelegate.cpp.

KIO::SkipDialog_Result KIO::JobUiDelegate::askSkip ( KJob *  job,
bool  multi,
const QString &  error_text 
)
virtual

See skipdialog.h

Definition at line 93 of file jobuidelegate.cpp.

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

Associate this job with a window given by window.

Parameters:
windowthe window to associate to
See also:
window()

Reimplemented from KDialogJobUiDelegate.

Definition at line 55 of file jobuidelegate.cpp.


Friends And Related Function Documentation

KIO::RenameDialog_Result KIO::JobUiDelegate::askFileRename ( KJob *  job,
const QString &  caption,
const QString &  src,
const QString &  dest,
KIO::RenameDialog_Mode  mode,
QString &  newDest,
KIO::filesize_t  sizeSrc = KIO::filesize_t(-1),
KIO::filesize_t  sizeDest = KIO::filesize_t(-1),
time_t  ctimeSrc = time_t(-1),
time_t  ctimeDest = time_t(-1),
time_t  mtimeSrc = time_t(-1),
time_t  mtimeDest = time_t(-1) 
)
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
modeparameters for the dialog (which buttons to show...), see RenameDialog_Mode
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

Definition at line 61 of file jobuidelegate.cpp.


The documentation for this class was generated from the following files:
  • jobuidelegate.h
  • jobuidelegate.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 16 2013 17:50:52 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal