• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KIO::JobUiDelegate

KIO::JobUiDelegate Class Reference

A UI delegate tuned to be used with KIO Jobs. More...

#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 }

Public Member Functions

bool askDeleteConfirmation (const KUrl::List &urls, DeletionType deletionType, ConfirmationType confirmationType)
virtual SkipDialog_Result askSkip (KJob *job, bool multi, const QString &error_text)
 JobUiDelegate ()
virtual void setWindow (QWidget *window)
virtual ~JobUiDelegate ()

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)

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 113 of file jobuidelegate.h.

enum KIO::JobUiDelegate::DeletionType

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

Enumerator:
Delete 
Trash 

Definition at line 106 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:
urls the urls about to be deleted/trashed
method 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

Definition at line 98 of file jobuidelegate.cpp.

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

For internal use only.

See skipdialog.h

Definition at line 88 of file jobuidelegate.cpp.

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

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 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:
caption the caption 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
mode parameters for the dialog (which buttons to show...), see RenameDialog_Mode
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

Definition at line 61 of file jobuidelegate.cpp.


The documentation for this class was generated from the following files:
  • jobuidelegate.h
  • jobuidelegate.cpp

KIO

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal