Namespaces
	HostInfo

	Integration

	SslUi

Classes
class	AbstractConnectionBackend

class	AccessManager

class	AnimationState

class	AuthInfo

struct	BasicOperation

class	CachedRendering

class	ChmodJob

class	ClipboardUpdater

class	CommandRecorder

class	ConnectedSlaveQueue

struct	CopyInfo

class	CopyJob

class	DataProtocol

class	DataSlave

class	DavJob

class	DefaultViewAdapter

class	DelegateAnimationHandler

class	DeleteJob

class	DirectCopyJob

class	DirectorySizeJob

class	FileCopyJob

class	FileJob

class	FileUndoManager

class	FileUndoManagerPrivate

class	ForwardingSlaveBase

class	HostQueue

class	ImageFilter

class	Job

class	JobPrivate

class	JobUiDelegate

class	KPasswdServer

class	KPasswdServerLoop

class	ListJob

class	MetaData

class	MetaInfoJob

class	MimetypeJob

class	MkdirJob

class	MultiGetJob

class	NetAccess

class	NetRC

class	PasswordDialog

class	PasteDialog

struct	PerSlaveQueue

class	PreviewJob

class	ProtoQueue

class	RenameDialog

class	RenameDialogPlugin

class	Scheduler

class	SerialPicker

class	SessionData

class	SimpleJob

class	SimpleJobPrivate

class	SkipDialog

class	Slave

class	SlaveBase

class	SlaveConfig

class	SlaveInterface

class	SlaveInterfacePrivate

class	SlaveKeeper

class	SocketConnectionBackend

class	SpecialJob

class	StatJob

class	StoredTransferJob

struct	Task

class	TCPSlaveBase

class	TransferJob

class	TransferJobPrivate

class	UDSEntry

class	UndoCommand

class	UserNotificationHandler

Typedefs
typedef qlonglong	fileoffset_t

typedef qulonglong	filesize_t

typedef QList< UDSEntry >	UDSEntryList

Enumerations
enum	CacheControl { CC_CacheOnly, CC_Cache, CC_Verify, CC_Refresh, CC_Reload }

enum	ChmodJobState { CHMODJOB_STATE_LISTING, CHMODJOB_STATE_CHMODING }

enum	Command { CMD_HOST = '0', CMD_CONNECT = '1', CMD_DISCONNECT = '2', CMD_SLAVE_STATUS = '3', CMD_SLAVE_CONNECT = '4', CMD_SLAVE_HOLD = '5', CMD_NONE = 'A', CMD_TESTDIR = 'B', CMD_GET = 'C', CMD_PUT = 'D', CMD_STAT = 'E', CMD_MIMETYPE = 'F', CMD_LISTDIR = 'G', CMD_MKDIR = 'H', CMD_RENAME = 'I', CMD_COPY = 'J', CMD_DEL = 'K', CMD_CHMOD = 'L', CMD_SPECIAL = 'M', CMD_SETMODIFICATIONTIME = 'N', CMD_REPARSECONFIGURATION = 'O', CMD_META_DATA = 'P', CMD_SYMLINK = 'Q', CMD_SUBURL = 'R', CMD_MESSAGEBOXANSWER = 'S', CMD_RESUMEANSWER = 'T', CMD_CONFIG = 'U', CMD_MULTI_GET = 'V', CMD_SETLINKDEST = 'W', CMD_OPEN = 'X', CMD_CHOWN = 'Y', CMD_READ = 'Z', CMD_WRITE = 91, CMD_SEEK = 92, CMD_CLOSE = 93, CMD_HOST_INFO = 94 }

enum	DeleteJobState { DELETEJOB_STATE_STATING, DELETEJOB_STATE_DELETING_FILES, DELETEJOB_STATE_DELETING_DIRS }

enum	Error { ERR_CANNOT_OPEN_FOR_READING = KJob::UserDefinedError + 1, ERR_CANNOT_OPEN_FOR_WRITING = KJob::UserDefinedError + 2, ERR_CANNOT_LAUNCH_PROCESS = KJob::UserDefinedError + 3, ERR_INTERNAL = KJob::UserDefinedError + 4, ERR_MALFORMED_URL = KJob::UserDefinedError + 5, ERR_UNSUPPORTED_PROTOCOL = KJob::UserDefinedError + 6, ERR_NO_SOURCE_PROTOCOL = KJob::UserDefinedError + 7, ERR_UNSUPPORTED_ACTION = KJob::UserDefinedError + 8, ERR_IS_DIRECTORY = KJob::UserDefinedError + 9, ERR_IS_FILE = KJob::UserDefinedError + 10, ERR_DOES_NOT_EXIST = KJob::UserDefinedError + 11, ERR_FILE_ALREADY_EXIST = KJob::UserDefinedError + 12, ERR_DIR_ALREADY_EXIST = KJob::UserDefinedError + 13, ERR_UNKNOWN_HOST = KJob::UserDefinedError + 14, ERR_ACCESS_DENIED = KJob::UserDefinedError + 15, ERR_WRITE_ACCESS_DENIED = KJob::UserDefinedError + 16, ERR_CANNOT_ENTER_DIRECTORY = KJob::UserDefinedError + 17, ERR_PROTOCOL_IS_NOT_A_FILESYSTEM = KJob::UserDefinedError + 18, ERR_CYCLIC_LINK = KJob::UserDefinedError + 19, ERR_USER_CANCELED = KJob::KilledJobError, ERR_CYCLIC_COPY = KJob::UserDefinedError + 21, ERR_COULD_NOT_CREATE_SOCKET = KJob::UserDefinedError + 22, ERR_COULD_NOT_CONNECT = KJob::UserDefinedError + 23, ERR_CONNECTION_BROKEN = KJob::UserDefinedError + 24, ERR_NOT_FILTER_PROTOCOL = KJob::UserDefinedError + 25, ERR_COULD_NOT_MOUNT = KJob::UserDefinedError + 26, ERR_COULD_NOT_UNMOUNT = KJob::UserDefinedError + 27, ERR_COULD_NOT_READ = KJob::UserDefinedError + 28, ERR_COULD_NOT_WRITE = KJob::UserDefinedError + 29, ERR_COULD_NOT_BIND = KJob::UserDefinedError + 30, ERR_COULD_NOT_LISTEN = KJob::UserDefinedError + 31, ERR_COULD_NOT_ACCEPT = KJob::UserDefinedError + 32, ERR_COULD_NOT_LOGIN = KJob::UserDefinedError + 33, ERR_COULD_NOT_STAT = KJob::UserDefinedError + 34, ERR_COULD_NOT_CLOSEDIR = KJob::UserDefinedError + 35, ERR_COULD_NOT_MKDIR = KJob::UserDefinedError + 37, ERR_COULD_NOT_RMDIR = KJob::UserDefinedError + 38, ERR_CANNOT_RESUME = KJob::UserDefinedError + 39, ERR_CANNOT_RENAME = KJob::UserDefinedError + 40, ERR_CANNOT_CHMOD = KJob::UserDefinedError + 41, ERR_CANNOT_DELETE = KJob::UserDefinedError + 42, ERR_SLAVE_DIED = KJob::UserDefinedError + 43, ERR_OUT_OF_MEMORY = KJob::UserDefinedError + 44, ERR_UNKNOWN_PROXY_HOST = KJob::UserDefinedError + 45, ERR_COULD_NOT_AUTHENTICATE = KJob::UserDefinedError + 46, ERR_ABORTED = KJob::UserDefinedError + 47, ERR_INTERNAL_SERVER = KJob::UserDefinedError + 48, ERR_SERVER_TIMEOUT = KJob::UserDefinedError + 49, ERR_SERVICE_NOT_AVAILABLE = KJob::UserDefinedError + 50, ERR_UNKNOWN = KJob::UserDefinedError + 51, ERR_UNKNOWN_INTERRUPT = KJob::UserDefinedError + 53, ERR_CANNOT_DELETE_ORIGINAL = KJob::UserDefinedError + 54, ERR_CANNOT_DELETE_PARTIAL = KJob::UserDefinedError + 55, ERR_CANNOT_RENAME_ORIGINAL = KJob::UserDefinedError + 56, ERR_CANNOT_RENAME_PARTIAL = KJob::UserDefinedError + 57, ERR_NEED_PASSWD = KJob::UserDefinedError + 58, ERR_CANNOT_SYMLINK = KJob::UserDefinedError + 59, ERR_NO_CONTENT = KJob::UserDefinedError + 60, ERR_DISK_FULL = KJob::UserDefinedError + 61, ERR_IDENTICAL_FILES = KJob::UserDefinedError + 62, ERR_SLAVE_DEFINED = KJob::UserDefinedError + 63, ERR_UPGRADE_REQUIRED = KJob::UserDefinedError + 64, ERR_POST_DENIED = KJob::UserDefinedError + 65, ERR_COULD_NOT_SEEK = KJob::UserDefinedError + 66, ERR_CANNOT_SETTIME = KJob::UserDefinedError + 67, ERR_CANNOT_CHOWN = KJob::UserDefinedError + 68, ERR_POST_NO_SIZE = KJob::UserDefinedError + 69 }

enum	Info { INF_TOTAL_SIZE = 10, INF_PROCESSED_SIZE = 11, INF_SPEED, INF_REDIRECTION = 20, INF_MIME_TYPE = 21, INF_ERROR_PAGE = 22, INF_WARNING = 23, INF_GETTING_FILE, INF_UNUSED = 25, INF_INFOMESSAGE, INF_META_DATA, INF_NETWORK_STATUS, INF_MESSAGEBOX, INF_POSITION }

enum	JobFlag { DefaultFlags = 0, HideProgressInfo = 1, Resume = 2, Overwrite = 4 }

enum	LoadType { Reload, NoReload }

enum	Message { MSG_DATA = 100, MSG_DATA_REQ, MSG_ERROR, MSG_CONNECTED, MSG_FINISHED, MSG_STAT_ENTRY, MSG_LIST_ENTRIES, MSG_RENAMED, MSG_RESUME, MSG_SLAVE_STATUS, MSG_SLAVE_ACK, MSG_NET_REQUEST, MSG_NET_DROP, MSG_NEED_SUBURL_DATA, MSG_CANRESUME, MSG_AUTH_KEY, MSG_DEL_AUTH_KEY, MSG_OPENED, MSG_WRITTEN, MSG_HOST_INFO_REQ }

enum	RenameDialog_Mode { M_OVERWRITE = 1, M_OVERWRITE_ITSELF = 2, M_SKIP = 4, M_SINGLE = 8, M_MULTI = 16, M_RESUME = 32, M_NORENAME = 64, M_ISDIR = 128 }

enum	RenameDialog_Result { R_RESUME = 6, R_RESUME_ALL = 7, R_OVERWRITE = 4, R_OVERWRITE_ALL = 5, R_SKIP = 2, R_AUTO_SKIP = 3, R_RENAME = 1, R_AUTO_RENAME = 8, R_CANCEL = 0 }

enum	SkipDialog_Result { S_SKIP = 1, S_AUTO_SKIP = 2, S_CANCEL = 0 }

enum	UndoState { MAKINGDIRS = 0, MOVINGFILES, STATINGFILE, REMOVINGDIRS, REMOVINGLINKS }

Functions
static int	animationDebugArea ()

QString	buildErrorString (int errorCode, const QString &errorText)

QString	buildHTMLErrorString (int errorCode, const QString &errorText, const KUrl *reqUrl=0L, int method=-1)

QTime	calculateRemaining (KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed)

unsigned int	calculateRemainingSeconds (KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed)

bool	canPasteMimeSource (const QMimeData *data)

SimpleJob *	chmod (const KUrl &url, int permissions)

ChmodJob *	chmod (const KFileItemList &lstItems, int permissions, int mask, const QString &newOwner, const QString &newGroup, bool recursive, JobFlags flags=DefaultFlags)

SimpleJob *	chown (const KUrl &url, const QString &owner, const QString &group)

QFile::Permissions	convertPermissions (int permissions)

QString	convertSeconds (unsigned int seconds)

QString	convertSize (KIO::filesize_t size)

QString	convertSizeFromKiB (KIO::filesize_t kibSize)

CopyJob *	copy (const KUrl &src, const KUrl &dest, JobFlags flags=DefaultFlags)

CopyJob *	copy (const KUrl::List &src, const KUrl &dest, JobFlags flags=DefaultFlags)

CopyJob *	copyAs (const KUrl &src, const KUrl &dest, JobFlags flags=DefaultFlags)

DavJob *	davPropFind (const KUrl &url, const QDomDocument &properties, const QString &depth, JobFlags flags=DefaultFlags)

DavJob *	davPropPatch (const KUrl &url, const QDomDocument &properties, JobFlags flags=DefaultFlags)

DavJob *	davReport (const KUrl &url, const QString &report, const QString &depth, JobFlags flags=DefaultFlags)

DavJob *	davSearch (const KUrl &url, const QString &nsURI, const QString &qName, const QString &query, JobFlags flags=DefaultFlags)

QString	decodeFileName (const QString &str)

DeleteJob *	del (const KUrl &src, JobFlags flags=DefaultFlags)

DeleteJob *	del (const KUrl::List &src, JobFlags flags=DefaultFlags)

DirectorySizeJob *	directorySize (const KUrl &directory)

DirectorySizeJob *	directorySize (const KFileItemList &lstItems)

QString	encodeFileName (const QString &str)

FileCopyJob *	file_copy (const KUrl &src, const KUrl &dest, int permissions=-1, JobFlags flags=DefaultFlags)

FileCopyJob *	file_copy (const KUrl &src, const KUrl &dest, JobFlags flags)

SimpleJob *	file_delete (const KUrl &src, JobFlags flags=DefaultFlags)

FileCopyJob *	file_move (const KUrl &src, const KUrl &dest, int permissions=-1, JobFlags flags=DefaultFlags)

FileCopyJob *	file_move (const KUrl &src, const KUrl &dest, JobFlags flags)

MetaInfoJob *	fileMetaInfo (const KFileItemList &items)

MetaInfoJob *	fileMetaInfo (const KUrl::List &items)

PreviewJob *	filePreview (const KFileItemList &items, int width, int height=0, int iconSize=0, int iconAlpha=70, bool scale=true, bool save=true, const QStringList *enabledPlugins=0)

PreviewJob *	filePreview (const KUrl::List &items, int width, int height=0, int iconSize=0, int iconAlpha=70, bool scale=true, bool save=true, const QStringList *enabledPlugins=0)

PreviewJob *	filePreview (const KFileItemList &items, const QSize &size, const QStringList *enabledPlugins=0)

TransferJob *	get (const KUrl &url, LoadType reload=NoReload, JobFlags flags=DefaultFlags)

QString	getCacheControlString (KIO::CacheControl cacheControl)

KJobTrackerInterface *	getJobTracker ()

TransferJob *	http_delete (const KUrl &url, JobFlags flags=DefaultFlags)

TransferJob *	http_post (const KUrl &url, const QByteArray &postData, JobFlags flags=DefaultFlags)

TransferJob *	http_post (const KUrl &url, QIODevice *device, qint64 size=-1, JobFlags flags=DefaultFlags)

SimpleJob *	http_update_cache (const KUrl &url, bool no_cache, time_t expireDate)

QString	itemsSummaryString (uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize)

CopyJob *	link (const KUrl &src, const KUrl &destDir, JobFlags flags=DefaultFlags)

CopyJob *	link (const KUrl::List &src, const KUrl &destDir, JobFlags flags=DefaultFlags)

CopyJob *	linkAs (const KUrl &src, const KUrl &dest, JobFlags flags=DefaultFlags)

ListJob *	listDir (const KUrl &url, JobFlags flags=DefaultFlags, bool includeHidden=true)

ListJob *	listRecursive (const KUrl &url, JobFlags flags=DefaultFlags, bool includeHidden=true)

MimetypeJob *	mimetype (const KUrl &url, JobFlags flags=DefaultFlags)

SimpleJob *	mkdir (const KUrl &url, int permissions=-1)

StatJob *	mostLocalUrl (const KUrl &url, JobFlags flags=DefaultFlags)

SimpleJob *	mount (bool ro, const QByteArray &fstype, const QString &dev, const QString &point, JobFlags flags=DefaultFlags)

CopyJob *	move (const KUrl &src, const KUrl &dest, JobFlags flags=DefaultFlags)

CopyJob *	move (const KUrl::List &src, const KUrl &dest, JobFlags flags=DefaultFlags)

CopyJob *	moveAs (const KUrl &src, const KUrl &dest, JobFlags flags=DefaultFlags)

MultiGetJob *	multi_get (long id, const KUrl &url, const MetaData &metaData)

QString	number (KIO::filesize_t size)

FileJob *	open (const KUrl &url, QIODevice::OpenMode mode)

QDataStream &	operator<< (QDataStream &s, const AuthInfo &a)

QDBusArgument &	operator<< (QDBusArgument &argument, const AuthInfo &a)

QDataStream &	operator>> (QDataStream &s, AuthInfo &a)

const QDBusArgument &	operator>> (const QDBusArgument &argument, AuthInfo &a)

KIO::CacheControl	parseCacheControl (const QString &cacheControl)

QString	pasteActionText ()

Job *	pasteClipboard (const KUrl &destURL, QWidget *widget, bool move=false)

void	pasteData (const KUrl &destURL, const QByteArray &data, QWidget *widget)

CopyJob *	pasteDataAsync (const KUrl &destURL, const QByteArray &data, QWidget *widget, const QString &dialogText=QString())

Job *	pasteMimeData (const QMimeData data, const KUrl &destUrl, const QString &dialogText, QWidget widget)

CopyJob *	pasteMimeSource (const QMimeData data, const KUrl &destURL, const QString &dialogText, QWidget widget, bool clipboard=false)

QPixmap	pixmapForUrl (const KUrl &_url, mode_t _mode=0, KIconLoader::Group _group=KIconLoader::Desktop, int _force_size=0, int _state=0, QString *_path=0)

TransferJob *	put (const KUrl &url, int permissions, JobFlags flags=DefaultFlags)

QByteArray	rawErrorDetail (int errorCode, const QString &errorText, const KUrl *reqUrl=0L, int method=-1)

static void	readConfig (KConfig config, const QString &group, MetaData metaData)

SimpleJob *	rename (const KUrl &src, const KUrl &dest, JobFlags flags=DefaultFlags)

SimpleJob *	rmdir (const KUrl &url)

SimpleJob *	setModificationTime (const KUrl &url, const QDateTime &mtime)

SimpleJob *	special (const KUrl &url, const QByteArray &data, JobFlags flags=DefaultFlags)

StatJob *	stat (const KUrl &url, JobFlags flags=DefaultFlags)

StatJob *	stat (const KUrl &url, KIO::StatJob::StatSide side, short int details, JobFlags flags=DefaultFlags)

StatJob *	stat (const KUrl &url, bool sideIsSource, short int details, JobFlags flags=DefaultFlags)

StoredTransferJob *	storedGet (const KUrl &url, LoadType reload=NoReload, JobFlags flags=DefaultFlags)

StoredTransferJob *	storedHttpPost (const QByteArray &arr, const KUrl &url, JobFlags flags=DefaultFlags)

StoredTransferJob *	storedHttpPost (QIODevice *device, const KUrl &url, qint64 size=-1, JobFlags flags=DefaultFlags)

StoredTransferJob *	storedPut (const QByteArray &arr, const KUrl &url, int permissions, JobFlags flags=DefaultFlags)

SimpleJob *	symlink (const QString &target, const KUrl &dest, JobFlags flags=DefaultFlags)

CopyJob *	trash (const KUrl &src, JobFlags flags=DefaultFlags)

CopyJob *	trash (const KUrl::List &src, JobFlags flags=DefaultFlags)

SimpleJob *	unmount (const QString &point, JobFlags flags=DefaultFlags)

QString	unsupportedActionErrorString (const QString &protocol, int cmd)

Variables
static const int	switchIconInterval = 1000

Detailed Description

A namespace for KIO globals.

Typedef Documentation

typedef qlonglong KIO::fileoffset_t

64-bit file offset

Definition at line 55 of file global.h.

typedef qulonglong KIO::filesize_t

64-bit file size

Definition at line 57 of file global.h.

typedef QList<UDSEntry> KIO::UDSEntryList

A directory listing is a list of UDSEntry instances.

To list the name and size of all the files in a directory listing you would do:

KIO::UDSEntryList::ConstIterator it = entries.begin();
const KIO::UDSEntryList::ConstIterator end = entries.end();
for (; it != end; ++it) {
  const KIO::UDSEntry& entry = *it;
  QString name = entry.stringValue( KIO::UDSEntry::UDS_NAME );
  bool isDir = entry.isDir();
  KIO::filesize_t size = entry.numberValue( KIO::UDSEntry::UDS_SIZE, -1 );
  ...
}

Definition at line 294 of file udsentry.h.

Enumeration Type Documentation

enum KIO::CacheControl

Specifies how to use the cache.

See also: parseCacheControl(); getCacheControlString()

Enumerator
CC_CacheOnly	Fail request if not in cache.
CC_Cache	Use cached entry if available.
CC_Verify	Validate cached entry with remote site if expired.
CC_Refresh	Always validate cached entry with remote site.
CC_Reload	Always fetch from remote site.

Definition at line 330 of file global.h.

enum KIO::ChmodJobState

Enumerator
CHMODJOB_STATE_LISTING
CHMODJOB_STATE_CHMODING

Definition at line 50 of file chmodjob.cpp.

enum KIO::Command

Commands that can be invoked by a job.

(Move this to a non-public header)

Enumerator
CMD_HOST
CMD_CONNECT
CMD_DISCONNECT
CMD_SLAVE_STATUS
CMD_SLAVE_CONNECT
CMD_SLAVE_HOLD
CMD_NONE
CMD_TESTDIR
CMD_GET
CMD_PUT
CMD_STAT
CMD_MIMETYPE
CMD_LISTDIR
CMD_MKDIR
CMD_RENAME
CMD_COPY
CMD_DEL
CMD_CHMOD
CMD_SPECIAL
CMD_SETMODIFICATIONTIME
CMD_REPARSECONFIGURATION
CMD_META_DATA
CMD_SYMLINK
CMD_SUBURL
CMD_MESSAGEBOXANSWER
CMD_RESUMEANSWER
CMD_CONFIG
CMD_MULTI_GET
CMD_SETLINKDEST
CMD_OPEN
CMD_CHOWN
CMD_READ
CMD_WRITE
CMD_SEEK
CMD_CLOSE
CMD_HOST_INFO

Definition at line 150 of file global.h.

enum KIO::DeleteJobState

Enumerator
DELETEJOB_STATE_STATING
DELETEJOB_STATE_DELETING_FILES
DELETEJOB_STATE_DELETING_DIRS

Definition at line 52 of file deletejob.cpp.

enum KIO::Error

Error codes that can be emitted by KIO.

Enumerator
ERR_CANNOT_OPEN_FOR_READING
ERR_CANNOT_OPEN_FOR_WRITING
ERR_CANNOT_LAUNCH_PROCESS
ERR_INTERNAL
ERR_MALFORMED_URL
ERR_UNSUPPORTED_PROTOCOL
ERR_NO_SOURCE_PROTOCOL
ERR_UNSUPPORTED_ACTION
ERR_IS_DIRECTORY
ERR_IS_FILE
ERR_DOES_NOT_EXIST
ERR_FILE_ALREADY_EXIST
ERR_DIR_ALREADY_EXIST
ERR_UNKNOWN_HOST
ERR_ACCESS_DENIED
ERR_WRITE_ACCESS_DENIED
ERR_CANNOT_ENTER_DIRECTORY
ERR_PROTOCOL_IS_NOT_A_FILESYSTEM
ERR_CYCLIC_LINK
ERR_USER_CANCELED
ERR_CYCLIC_COPY
ERR_COULD_NOT_CREATE_SOCKET
ERR_COULD_NOT_CONNECT
ERR_CONNECTION_BROKEN
ERR_NOT_FILTER_PROTOCOL
ERR_COULD_NOT_MOUNT
ERR_COULD_NOT_UNMOUNT
ERR_COULD_NOT_READ
ERR_COULD_NOT_WRITE
ERR_COULD_NOT_BIND
ERR_COULD_NOT_LISTEN
ERR_COULD_NOT_ACCEPT
ERR_COULD_NOT_LOGIN
ERR_COULD_NOT_STAT
ERR_COULD_NOT_CLOSEDIR
ERR_COULD_NOT_MKDIR
ERR_COULD_NOT_RMDIR
ERR_CANNOT_RESUME
ERR_CANNOT_RENAME
ERR_CANNOT_CHMOD
ERR_CANNOT_DELETE
ERR_SLAVE_DIED
ERR_OUT_OF_MEMORY
ERR_UNKNOWN_PROXY_HOST
ERR_COULD_NOT_AUTHENTICATE
ERR_ABORTED
ERR_INTERNAL_SERVER
ERR_SERVER_TIMEOUT
ERR_SERVICE_NOT_AVAILABLE
ERR_UNKNOWN
ERR_UNKNOWN_INTERRUPT
ERR_CANNOT_DELETE_ORIGINAL
ERR_CANNOT_DELETE_PARTIAL
ERR_CANNOT_RENAME_ORIGINAL
ERR_CANNOT_RENAME_PARTIAL
ERR_NEED_PASSWD
ERR_CANNOT_SYMLINK
ERR_NO_CONTENT
ERR_DISK_FULL
ERR_IDENTICAL_FILES
ERR_SLAVE_DEFINED
ERR_UPGRADE_REQUIRED
ERR_POST_DENIED
ERR_COULD_NOT_SEEK
ERR_CANNOT_SETTIME
ERR_CANNOT_CHOWN
ERR_POST_NO_SIZE

Definition at line 194 of file global.h.

enum KIO::Info

Identifiers for KIO informational messages.

Enumerator
INF_TOTAL_SIZE
INF_PROCESSED_SIZE
INF_SPEED
INF_REDIRECTION
INF_MIME_TYPE
INF_ERROR_PAGE
INF_WARNING
INF_GETTING_FILE
INF_UNUSED
INF_INFOMESSAGE
INF_META_DATA
INF_NETWORK_STATUS
INF_MESSAGEBOX
INF_POSITION

Definition at line 46 of file slaveinterface.h.

enum KIO::JobFlag

Flags for the job properties.

Not all flags are supported in all cases. Please see documentation of the calling function!

Enumerator
DefaultFlags	Show the progress info GUI, no Resume and no Overwrite.
HideProgressInfo	Hide progress information dialog, i.e. don't show a GUI.
Resume	When set, automatically append to the destination file if it exists already. WARNING: this is NOT the builtin support for offering the user to resume a previous partial download. The Resume option is much less used, it allows to append to an existing file. This is used by KIO::put(), KIO::file_copy(), KIO::file_move().
Overwrite	When set, automatically overwrite the destination if it exists already. This is used by KIO::rename(), KIO::put(), KIO::file_copy(), KIO::file_move(), KIO::symlink(). Otherwise the operation will fail with ERR_FILE_ALREADY_EXIST or ERR_DIR_ALREADY_EXIST.

Definition at line 42 of file jobclasses.h.

enum KIO::LoadType

Enumerator
Reload
NoReload

Definition at line 29 of file job.h.

enum KIO::Message

Identifiers for KIO data messages.

Enumerator
MSG_DATA
MSG_DATA_REQ
MSG_ERROR
MSG_CONNECTED
MSG_FINISHED
MSG_STAT_ENTRY
MSG_LIST_ENTRIES
MSG_RENAMED
MSG_RESUME
MSG_SLAVE_STATUS
MSG_SLAVE_ACK
MSG_NET_REQUEST
MSG_NET_DROP
MSG_NEED_SUBURL_DATA
MSG_CANRESUME
MSG_AUTH_KEY
MSG_DEL_AUTH_KEY
MSG_OPENED
MSG_WRITTEN
MSG_HOST_INFO_REQ

Definition at line 67 of file slaveinterface.h.

enum KIO::RenameDialog_Mode

M_OVERWRITE: We have an existing dest, show details about it and offer to overwrite it.

M_OVERWRITE_ITSELF: Warn that the current operation would overwrite a file with itself, which is not allowed. M_SKIP: Offer a "Skip" button, to skip other files too. Requires M_MULTI. M_SINGLE: Deprecated and unused, please ignore. M_MULTI: Set if the current operation concerns multiple files, so it makes sense to offer buttons that apply the user's choice to all files/folders. M_RESUME: Offer a "Resume" button (plus "Resume All" if M_MULTI) M_NORENAME: Don't offer a "Rename" button M_ISDIR: The dest is a directory, so label the "overwrite" button something like "merge" instead.

Enumerator
M_OVERWRITE
M_OVERWRITE_ITSELF
M_SKIP
M_SINGLE
M_MULTI
M_RESUME
M_NORENAME
M_ISDIR

Definition at line 56 of file renamedialog.h.

enum KIO::RenameDialog_Result

The result of open_RenameDialog().

Enumerator
R_RESUME
R_RESUME_ALL
R_OVERWRITE
R_OVERWRITE_ALL
R_SKIP
R_AUTO_SKIP
R_RENAME
R_AUTO_RENAME
R_CANCEL

Definition at line 61 of file renamedialog.h.

enum KIO::SkipDialog_Result

Enumerator
S_SKIP
S_AUTO_SKIP
S_CANCEL

Definition at line 29 of file skipdialog.h.

enum KIO::UndoState

Enumerator
MAKINGDIRS
MOVINGFILES
STATINGFILE
REMOVINGDIRS
REMOVINGLINKS

Definition at line 97 of file fileundomanager_p.h.

Function Documentation

static int KIO::animationDebugArea ( )

static

Definition at line 48 of file delegateanimationhandler.cpp.

QString KIO::buildErrorString	(	int	errorCode,
		const QString &	errorText
	)

Returns a translated error message for errorCode using the additional error information provided by errorText.

Parameters

errorCode	the error code
errorText	the additional error text

Returns: the created error string

Definition at line 164 of file global.cpp.

QString KIO::buildHTMLErrorString	(	int	errorCode,
		const QString &	errorText,
		const KUrl *	reqUrl = `0L`,
		int	method = `-1`
	)

Returns a translated html error message for errorCode using the additional error information provided by errorText , reqUrl (the request URL), and the ioslave method .

Parameters

errorCode	the error code
errorText	the additional error text
reqUrl	the request URL
method	the ioslave method

Returns: the created error string

QTime KIO::calculateRemaining	(	KIO::filesize_t	totalSize,
		KIO::filesize_t	processedSize,
		KIO::filesize_t	speed
	)

Calculates remaining time from total size, processed size and speed.

Warning: As QTime is limited to 23:59:59, use calculateRemainingSeconds() instead

Parameters

totalSize	total size in bytes
processedSize	processed size in bytes
speed	speed in bytes per second

Returns: calculated remaining time

Definition at line 95 of file global.cpp.

unsigned int KIO::calculateRemainingSeconds	(	KIO::filesize_t	totalSize,
		KIO::filesize_t	processedSize,
		KIO::filesize_t	speed
	)

Calculates remaining time in seconds from total size, processed size and speed.

Parameters

totalSize	total size in bytes
processedSize	processed size in bytes
speed	speed in bytes per second

Returns: calculated remaining time in seconds

Definition at line 70 of file global.cpp.

bool KIO::canPasteMimeSource ( const QMimeData * data )

Returns true if pasteMimeSource finds any interesting format in data.

You can use this method to enable/disable the paste action appropriately.

Since: 4.3

Definition at line 273 of file paste.cpp.

SimpleJob * KIO::chmod	(	const KUrl &	url,
		int	permissions
	)

Changes permissions on a file or directory.

See the other chmod in chmodjob.h for changing many files or directories.

Parameters

url	The URL of file or directory.
permissions	The permissions to set.

Returns: the job handling the operation.

Definition at line 711 of file job.cpp.

ChmodJob * KIO::chmod	(	const KFileItemList &	lstItems,
		int	permissions,
		int	mask,
		const QString &	newOwner,
		const QString &	newGroup,
		bool	recursive,
		JobFlags	flags = `DefaultFlags`
	)

Creates a job that changes permissions/ownership on several files or directories, optionally recursively.

This version of chmod uses a KFileItemList so that it directly knows what to do with the items. TODO: a version that takes a KUrl::List, and a general job that stats each url and returns a KFileItemList.

Note that change of ownership is only supported for local files.

Inside directories, the "x" bits will only be changed for files that had at least one "x" bit before, and for directories. This emulates the behavior of chmod +X.

Parameters

lstItems	The file items representing several files or directories.
permissions	the permissions we want to set
mask	the bits we are allowed to change. For instance, if mask is 0077, we don't change the "user" bits, only "group" and "others".
newOwner	If non-empty, the new owner for the files
newGroup	If non-empty, the new group for the files
recursive	whether to open directories recursively
flags	We support HideProgressInfo here

Returns: The job handling the operation.

Definition at line 268 of file chmodjob.cpp.

SimpleJob * KIO::chown	(	const KUrl &	url,
		const QString &	owner,
		const QString &	group
	)

Changes ownership and group of a file or directory.

Parameters

url	The URL of file or directory.
owner	the new owner
group	the new group

Returns: the job handling the operation.

Definition at line 718 of file job.cpp.

QFile::Permissions KIO::convertPermissions ( int permissions )

Converts KIO file permissions from mode_t to QFile::Permissions format.

This is a convenience function for converting KIO permissions parameter from mode_t to QFile::Permissions.

Parameters

permissions KIO file permissions.

Returns: -1 if permissions is -1, otherwise its OR'ed QFile::Permission equivalent.

Since: 4.12

Definition at line 1251 of file global.cpp.

QString KIO::convertSeconds ( unsigned int seconds )

Convert seconds to a string representing number of days, hours, minutes and seconds.

Parameters

seconds number of seconds to convert

Returns: string representation in a locale depending format

Definition at line 79 of file global.cpp.

QString KIO::convertSize ( KIO::filesize_t size )

Converts size from bytes to the string representation.

Parameters

size	size in bytes

Returns: converted size as a string - e.g. 123.4 KiB , 12.0 MiB

Definition at line 53 of file global.cpp.

QString KIO::convertSizeFromKiB ( KIO::filesize_t kibSize )

Converts size from kibi-bytes (2^10) to the string representation.

Parameters

kibSize size in kibi-bytes (2^10)

Returns: converted size as a string - e.g. 123.4 KiB , 12.0 MiB

Definition at line 58 of file global.cpp.

CopyJob * KIO::copy	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Copy a file or directory src into the destination dest, which can be a file (including the final filename) or a directory (into which src will be copied).

This emulates the cp command completely.

Parameters

src	the file or directory to copy
dest	the destination
flags	copy() supports HideProgressInfo and Overwrite. Note: Overwrite has the meaning of both "write into existing directories" and "overwrite existing files". However if "dest" exists, then src is copied into a subdir of dest, just like "cp" does. Use copyAs if you don't want that.

Returns: the job handling the operation

See also: copyAs()

Definition at line 2164 of file copyjob.cpp.

CopyJob * KIO::copy	(	const KUrl::List &	src,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Copy a list of file/dirs src into a destination directory dest.

Parameters

src	the list of files and/or directories
dest	the destination
flags	copy() supports HideProgressInfo and Overwrite. Note: Overwrite has the meaning of both "write into existing directories" and "overwrite existing files". However if "dest" exists, then src is copied into a subdir of dest, just like "cp" does.

Returns: the job handling the operation

Definition at line 2180 of file copyjob.cpp.

CopyJob * KIO::copyAs	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Copy a file or directory src into the destination dest, which is the destination name in any case, even for a directory.

As opposed to copy(), this doesn't emulate cp, but is the only way to copy a directory, giving it a new name and getting an error box if a directory already exists with the same name (or writing the contents of src into dest, when using Overwrite).

Parameters

src	the file or directory to copy
dest	the destination
flags	copyAs() supports HideProgressInfo and Overwrite. Note: Overwrite has the meaning of both "write into existing directories" and "overwrite existing files".

Returns
the job handling the operation

Definition at line 2172 of file copyjob.cpp.

DavJob * KIO::davPropFind	(	const KUrl &	url,
		const QDomDocument &	properties,
		const QString &	depth,
		JobFlags	flags = `DefaultFlags`
	)

Creates a new DavJob that issues a PROPFIND command.

PROPFIND retrieves the properties of the resource identified by the given url.

Parameters

url	the URL of the resource
properties	a propfind document that describes the properties that should be retrieved
depth	the depth of the request. Can be "0", "1" or "infinity"
flags	We support HideProgressInfo here

Returns: the new DavJob

Definition at line 144 of file davjob.cpp.

DavJob * KIO::davPropPatch	(	const KUrl &	url,
		const QDomDocument &	properties,
		JobFlags	flags = `DefaultFlags`
	)

Creates a new DavJob that issues a PROPPATCH command.

PROPPATCH sets the properties of the resource identified by the given url.

Parameters

url	the URL of the resource
properties	a PROPPACTCH document that describes the properties that should be modified and its new values
flags	We support HideProgressInfo here

Returns: the new DavJob

Definition at line 152 of file davjob.cpp.

DavJob * KIO::davReport	(	const KUrl &	url,
		const QString &	report,
		const QString &	depth,
		JobFlags	flags = `DefaultFlags`
	)

Creates a new DavJob that issues a REPORT command.

Parameters

url	the URL of the resource
report	a REPORT document that describes the request to make
depth	the depth of the request. Can be "0", "1" or "infinity"
flags	We support HideProgressInfo here

Returns: the new DavJob

Since: 4.4

Definition at line 170 of file davjob.cpp.

DavJob * KIO::davSearch	(	const KUrl &	url,
		const QString &	nsURI,
		const QString &	qName,
		const QString &	query,
		JobFlags	flags = `DefaultFlags`
	)

Creates a new DavJob that issues a SEARCH command.

Parameters

url	the URL of the resource
nsURI	the URI of the search method's qualified name
qName	the local part of the search method's qualified name
query	the search string
flags	We support HideProgressInfo here

Returns: the new DavJob

Definition at line 158 of file davjob.cpp.

QString KIO::decodeFileName ( const QString & str )

Decodes (from the filename to the text displayed) This doesn't do anything anymore, it used to do the opposite of encodeFileName when encodeFileName was using %2F for '/'.

Parameters

str	the file name to decode

Returns: the decoded file name

Definition at line 153 of file global.cpp.

DeleteJob * KIO::del	(	const KUrl &	src,
		JobFlags	flags = `DefaultFlags`
	)

Delete a file or directory.

Parameters

src	file to delete
flags	We support HideProgressInfo here

Returns: the job handling the operation

Definition at line 492 of file deletejob.cpp.

DeleteJob * KIO::del	(	const KUrl::List &	src,
		JobFlags	flags = `DefaultFlags`
	)

Deletes a list of files or directories.

Parameters

src	the files to delete
flags	We support HideProgressInfo here

Returns: the job handling the operation

Definition at line 501 of file deletejob.cpp.

DirectorySizeJob * KIO::directorySize ( const KUrl & directory )

Computes a directory size (by doing a recursive listing).

Connect to the result signal (this is the preferred solution to avoid blocking the GUI), or use exec() for a synchronous (blocking) calculation.

This one lists a single directory.

Definition at line 202 of file directorysizejob.cpp.

DirectorySizeJob * KIO::directorySize ( const KFileItemList & lstItems )

Computes a directory size (by doing a recursive listing).

Connect to the result signal (this is the preferred solution to avoid blocking the GUI), or use exec() for a synchronous (blocking) calculation.

This one lists the items from lstItems. The reason we asks for items instead of just urls, is so that we directly know if the item is a file or a directory, and in case of a file, we already have its size.

Definition at line 208 of file directorysizejob.cpp.

QString KIO::encodeFileName ( const QString & str )

Encodes (from the text displayed to the real filename) This translates '/' into a "unicode fraction slash", QChar(0x2044).

Used by KIO::link, for instance.

Parameters

str	the file name to encode

Returns: the encoded file name

Definition at line 146 of file global.cpp.

FileCopyJob * KIO::file_copy	(	const KUrl &	src,
		const KUrl &	dest,
		int	permissions = `-1`,
		JobFlags	flags = `DefaultFlags`
	)

Copy a single file.

Uses either SlaveBase::copy() if the slave supports that or get() and put() otherwise.

Parameters

src	Where to get the file.
dest	Where to put the file.
permissions	May be -1. In this case no special permission mode is set.
flags	Can be HideProgressInfo, Overwrite and Resume here. WARNING: Setting Resume means that the data will be appended to `dest` if `dest` exists.

Returns: the job handling the operation.

Definition at line 2473 of file job.cpp.

FileCopyJob* KIO::file_copy	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags
	)

Overload for catching code mistakes.

Do NOT call this method (it is not implemented), insert a value for permissions (-1 by default) before the JobFlags.

Since: 4.5

SimpleJob * KIO::file_delete	(	const KUrl &	src,
		JobFlags	flags = `DefaultFlags`
	)

Delete a single file.

Parameters

src	File to delete.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 2487 of file job.cpp.

FileCopyJob * KIO::file_move	(	const KUrl &	src,
		const KUrl &	dest,
		int	permissions = `-1`,
		JobFlags	flags = `DefaultFlags`
	)

Move a single file.

Use either SlaveBase::rename() if the slave supports that, or copy() and del() otherwise, or eventually get() & put() & del()

Parameters

src	Where to get the file.
dest	Where to put the file.
permissions	May be -1. In this case no special permission mode is set.
flags	Can be HideProgressInfo, Overwrite and Resume here. WARNING: Setting Resume means that the data will be appended to `dest` if `dest` exists.

Returns: the job handling the operation.

Definition at line 2479 of file job.cpp.

FileCopyJob* KIO::file_move	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags
	)

Overload for catching code mistakes.

Do NOT call this method (it is not implemented), insert a value for permissions (-1 by default) before the JobFlags.

Since: 4.3

MetaInfoJob * KIO::fileMetaInfo ( const KFileItemList & items )

Retrieves meta information for the given items.

Parameters

items files to get metainfo for

Returns: the MetaInfoJob to retrieve the items

Deprecated:: use strigi or KFileMetaInfo

Definition at line 159 of file metainfojob.cpp.

MetaInfoJob * KIO::fileMetaInfo ( const KUrl::List & items )

Retrieves meta information for the given items.

Parameters

items files to get metainfo for

Returns: the MetaInfoJob to retrieve the items

Deprecated:: use strigi or KFileMetaInfo

Definition at line 164 of file metainfojob.cpp.

PreviewJob * KIO::filePreview	(	const KFileItemList &	items,
		int	width,
		int	height = `0`,
		int	iconSize = `0`,
		int	iconAlpha = `70`,
		bool	scale = `true`,
		bool	save = `true`,
		const QStringList *	enabledPlugins = `0`
	)

Creates a PreviewJob to generate or retrieve a preview image for the given URL.

Parameters

items	files to get previews for
width	the maximum width to use
height	the maximum height to use, if this is 0, the same value as width is used.
iconSize	the size of the mimetype icon to overlay over the preview or zero to not overlay an icon. This has no effect if the preview plugin that will be used doesn't use icon overlays.
iconAlpha	transparency to use for the icon overlay
scale	if the image is to be scaled to the requested size or returned in its original size
save	if the image should be cached for later use
enabledPlugins	if non-zero, this points to a list containing the names of the plugins that may be used.

Returns: the new PreviewJob

See also: PreviewJob::availablePlugins()

Deprecated:: Use KIO::filePreview(KFileItemList, QSize, QStringList) in combination with the setter-methods instead. Note that the semantics of enabledPlugins has been slightly changed.

Definition at line 755 of file previewjob.cpp.

PreviewJob * KIO::filePreview	(	const KUrl::List &	items,
		int	width,
		int	height = `0`,
		int	iconSize = `0`,
		int	iconAlpha = `70`,
		bool	scale = `true`,
		bool	save = `true`,
		const QStringList *	enabledPlugins = `0`
	)

Creates a PreviewJob to generate or retrieve a preview image for the given URL.

Parameters

items	files to get previews for
width	the maximum width to use
height	the maximum height to use, if this is 0, the same value as width is used.
iconSize	the size of the mimetype icon to overlay over the preview or zero to not overlay an icon. This has no effect if the preview plugin that will be used doesn't use icon overlays.
iconAlpha	transparency to use for the icon overlay
scale	if the image is to be scaled to the requested size or returned in its original size
save	if the image should be cached for later use
enabledPlugins	if non-zero, this points to a list containing the names of the plugins that may be used.

Returns: the new PreviewJob

See also: PreviewJob::availablePlugins()

Deprecated:: Use KIO::filePreview(KFileItemList, QSize, QStringList) in combination with the setter-methods instead. Note that the semantics of enabledPlugins has been slightly changed.

Definition at line 763 of file previewjob.cpp.

PreviewJob * KIO::filePreview	(	const KFileItemList &	items,
		const QSize &	size,
		const QStringList *	enabledPlugins = `0`
	)

Creates a PreviewJob to generate a preview image for the given items.

Parameters

items	List of files to create previews for.
size	Desired size of the preview.
enabledPlugins	If non-zero it defines the list of plugins that are considered for generating the preview. If enabledPlugins is zero the plugins specified in the KConfigGroup "PreviewSettings" are used.

Since: 4.7

Definition at line 777 of file previewjob.cpp.

TransferJob * KIO::get	(	const KUrl &	url,
		LoadType	reload = `NoReload`,
		JobFlags	flags = `DefaultFlags`
	)

Get (a.k.a.

read). This is the job to use in order to "download" a file into memory. The slave emits the data through the data() signal.

Special case: if you want to determine the mimetype of the file first, and then read it with the appropriate component, you can still use a KIO::get() directly. When that job emits the mimeType signal, (which is guaranteed to happen before it emits any data), put the job on hold: job->putOnHold(); KIO::Scheduler::publishSlaveOnHold(); and forget about the job. The next time someone does a KIO::get() on the same URL (even in another process) this job will be resumed. This saves KIO from doing two requests to the server.

Parameters

url	the URL of the file
reload	Reload to reload the file, NoReload if it can be taken from the cache
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 1369 of file job.cpp.

QString KIO::getCacheControlString ( KIO::CacheControl cacheControl )

Returns a string representation of the given cache control method.

Parameters

cacheControl the cache control method

Returns: the string representation

See also: parseCacheControl()

Definition at line 1223 of file global.cpp.

KJobTrackerInterface * KIO::getJobTracker ( )

Definition at line 1246 of file global.cpp.

TransferJob * KIO::http_delete	(	const KUrl &	url,
		JobFlags	flags = `DefaultFlags`
	)

HTTP DELETE.

Though this function servers the same purpose as KIO::file_delete, unlike file_delete it accomodates HTTP sepecific actions such as redirections.

Parameters

src	url resource to delete.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Since: 4.7.3

Definition at line 1637 of file job.cpp.

TransferJob * KIO::http_post	(	const KUrl &	url,
		const QByteArray &	postData,
		JobFlags	flags = `DefaultFlags`
	)

HTTP POST (for form data).

Example:

job = KIO::http_post( url, postData, KIO::HideProgressInfo);
job->addMetaData("content-type", contentType);
job->addMetaData("referrer", referrerURL);

You MUST specify the "content-type" meta data. It is mandatory. It can be preceeded with the optional text "Content-Type:", e.g. "Content-Type: application/x-www-form-urlencoded".

postData is usually an encoded ASCII string (without null-termination!) and can contain spaces, linefeeds and percent escaped characters such as %20, %0A and %25.

Parameters

url	Where to write the data.
postData	Encoded data to post.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 1597 of file job.cpp.

TransferJob * KIO::http_post	(	const KUrl &	url,
		QIODevice *	device,
		qint64	size = `-1`,
		JobFlags	flags = `DefaultFlags`
	)

HTTP POST.

This function, unlike the one that accepts a QByteArray, accepts an IO device from which to read the encoded data to be posted to the server in order to to avoid holding the content of very large post requests, e.g. multimedia file uploads, in memory.

Example:

job = KIO::http_post( url, device, device->size(), KIO::HideProgressInfo);
job->addMetaData("content-type", contentType);
job->addMetaData("referrer", referrerURL);

You MUST specify the "content-type" meta data. It is mandatory. It can be preceeded with the optional text "Content-Type:", e.g. "Content-Type: application/x-www-form-urlencoded".

Parameters

url	Where to write the data.
device	the QIODevice that provides the encoded post data.
size	Size of the encoded post data.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Since: 4.7

Definition at line 1607 of file job.cpp.

SimpleJob * KIO::http_update_cache	(	const KUrl &	url,
		bool	no_cache,
		time_t	expireDate
	)

HTTP cache update.

Parameters

url	Url to update, protocol must be "http".
no_cache	If true, cache entry for `url` is deleted.
expireDate	Local machine time indicating when the entry is supposed to expire.

Returns: the job handling the operation.

Definition at line 962 of file job.cpp.

QString KIO::itemsSummaryString	(	uint	items,
		uint	files,
		uint	dirs,
		KIO::filesize_t	size,
		bool	showSize
	)

Helper for showing information about a set of files and directories.

Parameters

items	the number of items (= `files` + `dirs` + number of symlinks :)
files	the number of files
dirs	the number of dirs
size	the sum of the size of the `files`
showSize	whether to show the size in the result

Returns: the summary string

Definition at line 119 of file global.cpp.

CopyJob * KIO::link	(	const KUrl &	src,
		const KUrl &	destDir,
		JobFlags	flags = `DefaultFlags`
	)

Create a link.

If the protocols and hosts are the same, a Unix symlink will be created. Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.

Parameters

src	The existing file or directory, 'target' of the link.
destDir	Destination directory where the link will be created.
flags	link() supports HideProgressInfo only

Returns: the job handling the operation

Definition at line 2214 of file copyjob.cpp.

CopyJob * KIO::link	(	const KUrl::List &	src,
		const KUrl &	destDir,
		JobFlags	flags = `DefaultFlags`
	)

Create several links If the protocols and hosts are the same, a Unix symlink will be created.

Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.

Parameters

src	The existing files or directories, 'targets' of the link.
destDir	Destination directory where the links will be created.
flags	link() supports HideProgressInfo only

Returns: the job handling the operation

See also: link()

Definition at line 2221 of file copyjob.cpp.

CopyJob * KIO::linkAs	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Create a link.

Unlike link() this operation will fail when the directory already exists. If the protocols and hosts are the same, a Unix symlink will be created. Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.

Parameters

src	The existing file or directory, 'target' of the link.
dest	Destination directory where the link will be created.
flags	linkAs() supports HideProgressInfo only

Returns: the job handling the operation

See also: link (); copyAs()

Definition at line 2226 of file copyjob.cpp.

ListJob * KIO::listDir	(	const KUrl &	url,
		JobFlags	flags = `DefaultFlags`,
		bool	includeHidden = `true`
	)

List the contents of url, which is assumed to be a directory.

"." and ".." are returned, filter them out if you don't want them.

Parameters

url	the url of the directory
flags	Can be HideProgressInfo here
includeHidden	true for all files, false to cull out UNIX hidden files/dirs (whose names start with dot)

Returns: the job handling the operation.

Definition at line 2735 of file job.cpp.

ListJob * KIO::listRecursive	(	const KUrl &	url,
		JobFlags	flags = `DefaultFlags`,
		bool	includeHidden = `true`
	)

The same as the previous method, but recurses subdirectories.

Directory links are not followed.

"." and ".." are returned but only for the toplevel directory. Filter them out if you don't want them.

Parameters

url	the url of the directory
flags	Can be HideProgressInfo here
includeHidden	true for all files, false to cull out UNIX hidden files/dirs (whose names start with dot)

Returns: the job handling the operation.

Definition at line 2740 of file job.cpp.

MimetypeJob * KIO::mimetype	(	const KUrl &	url,
		JobFlags	flags = `DefaultFlags`
	)

Find mimetype for one file or directory.

If you are going to download the file right after determining its mimetype, then don't use this, prefer using a KIO::get() job instead. See the note about putting the job on hold once the mimetype is determined.

Parameters

url	the URL of the file
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 1856 of file job.cpp.

SimpleJob * KIO::mkdir	(	const KUrl &	url,
		int	permissions = `-1`
	)

Creates a single directory.

Parameters

url	The URL of the directory to create.
permissions	The permissions to set after creating the directory (unix-style), -1 for default permissions.

Returns: A pointer to the job handling the operation.

Definition at line 697 of file job.cpp.

StatJob * KIO::mostLocalUrl	(	const KUrl &	url,
		JobFlags	flags = `DefaultFlags`
	)

Tries to map a local URL for the given URL, using a KIO job.

Starts a (stat) job for determining the "most local URL" for a given URL. Retrieve the result with StatJob::mostLocalUrl in the result slot.

Parameters

url	The URL we are testing.

Since: 4.4

Definition at line 930 of file job.cpp.

SimpleJob * KIO::mount	(	bool	ro,
		const QByteArray &	fstype,
		const QString &	dev,
		const QString &	point,
		JobFlags	flags = `DefaultFlags`
	)

Mount filesystem.

Special job for kio_file.

Parameters

ro	Mount read-only if `true`.
fstype	File system type (e.g. "ext2", can be empty).
dev	Device (e.g. /dev/sda0).
point	Mount point, can be `null`.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 751 of file job.cpp.

CopyJob * KIO::move	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Moves a file or directory src to the given destination dest.

Parameters

src	the file or directory to copy
dest	the destination
flags	move() supports HideProgressInfo and Overwrite. Note: Overwrite has the meaning of both "write into existing directories" and "overwrite existing files". However if "dest" exists, then src is copied into a subdir of dest, just like "cp" does.

Returns: the job handling the operation

See also: copy(); moveAs()

Definition at line 2186 of file copyjob.cpp.

CopyJob * KIO::move	(	const KUrl::List &	src,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Moves a list of files or directories src to the given destination dest.

Parameters

src	the list of files or directories to copy
dest	the destination
flags	move() supports HideProgressInfo and Overwrite. Note: Overwrite has the meaning of both "write into existing directories" and "overwrite existing files". However if "dest" exists, then src is copied into a subdir of dest, just like "cp" does.

Returns: the job handling the operation

See also: copy()

Definition at line 2206 of file copyjob.cpp.

CopyJob * KIO::moveAs	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Moves a file or directory src to the given destination dest.

Unlike move() this operation will not move src into dest when dest exists: it will either fail, or move the contents of src into it if Overwrite is set.

Parameters

src	the file or directory to copy
dest	the destination
flags	moveAs() supports HideProgressInfo and Overwrite. Note: Overwrite has the meaning of both "write into existing directories" and "overwrite existing files".

Returns: the job handling the operation

See also: copyAs()

Definition at line 2196 of file copyjob.cpp.

MultiGetJob * KIO::multi_get	(	long	id,
		const KUrl &	url,
		const MetaData &	metaData
	)

Creates a new multiple get job.

Parameters

id	the id of the get operation
url	the URL of the file
metaData	the MetaData associated with the file

Returns: the job handling the operation.

See also: get()

Definition at line 3005 of file job.cpp.

QString KIO::number ( KIO::filesize_t size )

Converts a size to a string representation Not unlike QString::number(...)

Parameters

size	size in bytes

Returns: converted size as a string - e.g. 123456789

Definition at line 63 of file global.cpp.

FileJob * KIO::open	(	const KUrl &	url,
		QIODevice::OpenMode	mode
	)

Open ( random access I/O )

The file-job emits open() when opened

Parameters

url	the URL of the file
mode	the access privileges: see OpenMode

Returns: The file-handling job. It will never return 0. Errors are handled asynchronously (emitted as signals).

Definition at line 211 of file filejob.cpp.

QDataStream & KIO::operator<<	(	QDataStream &	s,
		const AuthInfo &	a
	)

Definition at line 209 of file authinfo.cpp.

QDBusArgument & KIO::operator<<	(	QDBusArgument &	argument,
		const AuthInfo &	a
	)

Definition at line 230 of file authinfo.cpp.

QDataStream & KIO::operator>>	(	QDataStream &	s,
		AuthInfo &	a
	)

Definition at line 219 of file authinfo.cpp.

const QDBusArgument & KIO::operator>>	(	const QDBusArgument &	argument,
		AuthInfo &	a
	)

Definition at line 242 of file authinfo.cpp.

KIO::CacheControl KIO::parseCacheControl ( const QString & cacheControl )

Parses the string representation of the cache control option.

Parameters

cacheControl the string representation

Returns: the cache control value

See also: getCacheControlString()

Definition at line 1204 of file global.cpp.

QString KIO::pasteActionText ( )

Returns the text to use for the Paste action, when the application supports pasting files, urls, and clipboard data, using pasteClipboard().

Returns: a string suitable for KAction::setText, or an empty string if pasting isn't possible right now.

Definition at line 366 of file paste.cpp.

KIO::Job * KIO::pasteClipboard	(	const KUrl &	destURL,
		QWidget *	widget,
		bool	move = `false`
	)

Pastes the content of the clipboard to the given destination URL.

URLs are treated separately (performing a file copy) from other data (which is saved into a file after asking the user to choose a filename and the preferred data format)

Parameters

destURL	the URL to receive the data
widget	parent widget to use for dialogs
move	true to move the data, false to copy – now ignored and handled automatically

Returns: the job that handles the operation

See also: pasteData()

Definition at line 315 of file paste.cpp.

void KIO::pasteData	(	const KUrl &	destURL,
		const QByteArray &	data,
		QWidget *	widget
	)

Pastes the given data to the given destination URL.

NOTE: This method is blocking (uses NetAccess for saving the data). Please consider using pasteDataAsync instead.

Parameters

destURL	the URL of the directory where the data will be pasted. The filename to use in that directory is prompted by this method.
data	the data to copy
widget	parent widget to use for dialogs

See also: pasteClipboard()

This method is a candidate for disappearing in KDE5, email faure at kde.org if you are using it in your application, then I'll reconsider.

Definition at line 341 of file paste.cpp.

KIO::CopyJob * KIO::pasteDataAsync	(	const KUrl &	destURL,
		const QByteArray &	data,
		QWidget *	widget,
		const QString &	dialogText = `QString()`
	)

Pastes the given data to the given destination URL.

Note that this method requires the caller to have chosen the QByteArray to paste before hand, unlike pasteClipboard and pasteMimeSource.

Parameters

destURL	the URL of the directory where the data will be pasted. The filename to use in that directory is prompted by this method.
data	the data to copy
dialogText	the text to show in the dialog

See also: pasteClipboard()

This method is a candidate for disappearing in KDE5, email faure at kde.org if you are using it in your application, then I'll reconsider.

Definition at line 352 of file paste.cpp.

KIO::Job * KIO::pasteMimeData	(	const QMimeData *	data,
		const KUrl &	destUrl,
		const QString &	dialogText,
		QWidget *	widget
	)

Save the given mime data to the given destination URL after offering the user to choose a data format.

This is the method used when handling drops (of anything else than URLs) onto dolphin and konqueror.

Parameters

data	the QMimeData, usually from a QDropEvent
destUrl	the URL of the directory where the data will be pasted. The filename to use in that directory is prompted by this method.
dialogText	the text to show in the dialog
widget	parent widget to use for dialogs
clipboard	whether the QMimeData comes from QClipboard. If you use pasteClipboard for that case, you never have to worry about this parameter.

See also: pasteClipboard()

Definition at line 383 of file paste.cpp.

KIO::CopyJob * KIO::pasteMimeSource	(	const QMimeData *	data,
		const KUrl &	destURL,
		const QString &	dialogText,
		QWidget *	widget,
		bool	clipboard = `false`
	)

Deprecated:: because it returns a CopyJob*, and this is better implemented without a copy job. Use pasteMimeData instead. Note that you'll have to tell the user in case of an error (no data to paste), while pasteMimeSource did that.

Definition at line 230 of file paste.cpp.

QPixmap KIO::pixmapForUrl	(	const KUrl &	_url,
		mode_t	_mode = `0`,
		KIconLoader::Group	_group = `KIconLoader::Desktop`,
		int	_force_size = `0`,
		int	_state = `0`,
		QString *	_path = `0`
	)

Convenience method to find the pixmap for a URL.

Call this one when you don't know the mimetype.

Parameters

_url	URL for the file.
_mode	the mode of the file. The mode may modify the icon with overlays that show special properties of the icon. Use 0 for default
_group	The icon group where the icon is going to be used.
_force_size	Override globally configured icon size. Use 0 for the default size
_state	The icon state, one of: KIconLoader::DefaultState, KIconLoader::ActiveState or KIconLoader::DisabledState.
_path	Output parameter to get the full path. Seldom needed. Ignored if 0

Returns: the pixmap of the URL, can be a default icon if not found

Definition at line 1239 of file global.cpp.

TransferJob * KIO::put	(	const KUrl &	url,
		int	permissions,
		JobFlags	flags = `DefaultFlags`
	)

Put (a.k.a.

write)

Parameters

url	Where to write data.
permissions	May be -1. In this case no special permission mode is set.
flags	Can be HideProgressInfo, Overwrite and Resume here. WARNING: Setting Resume means that the data will be appended to `dest` if `dest` exists.

Returns: the job handling the operation.

See also: multi_get()

Definition at line 1700 of file job.cpp.

QByteArray KIO::rawErrorDetail	(	int	errorCode,
		const QString &	errorText,
		const KUrl *	reqUrl = `0L`,
		int	method = `-1`
	)

Returns translated error details for errorCode using the additional error information provided by errorText , reqUrl (the request URL), and the ioslave method .

Parameters

errorCode	the error code
errorText	the additional error text
reqUrl	the request URL
method	the ioslave method

Returns

the following data:

QString errorName - the name of the error
QString techName - if not null, the more technical name of the error
QString description - a description of the error
QStringList causes - a list of possible causes of the error
QStringList solutions - a liso of solutions for the error

Definition at line 473 of file global.cpp.

static void KIO::readConfig	(	KConfig *	config,
		const QString &	group,
		MetaData *	metaData
	)

static

Definition at line 51 of file slaveconfig.cpp.

SimpleJob * KIO::rename	(	const KUrl &	src,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Rename a file or directory.

Warning: this operation fails if a direct renaming is not possible (like with files or dirs on separate partitions) Use move or file_move in this case.

Parameters

src	The original URL
dest	The final URL
flags	Can be Overwrite here

Returns: the job handling the operation.

Definition at line 731 of file job.cpp.

SimpleJob * KIO::rmdir ( const KUrl & url )

Removes a single directory.

The directory is assumed to be empty. The job will fail if the directory is not empty. Use KIO::del() (DeleteJob) to delete non-empty directories.

Parameters

url	The URL of the directory to remove.

Returns: A pointer to the job handling the operation.

Definition at line 704 of file job.cpp.

SimpleJob * KIO::setModificationTime	(	const KUrl &	url,
		const QDateTime &	mtime
	)

Changes the modification time on a file or directory.

Parameters

url	The URL of file or directory.
permissions	The permissions to set.

Returns: the job handling the operation.

Definition at line 724 of file job.cpp.

SimpleJob * KIO::special	(	const KUrl &	url,
		const QByteArray &	data,
		JobFlags	flags = `DefaultFlags`
	)

Execute any command that is specific to one slave (protocol).

Examples are : HTTP POST, mount and unmount (kio_file)

Parameters

url	The URL isn't passed to the slave, but is used to know which slave to send it to :-)
data	Packed data. The meaning is completely dependent on the slave, but usually starts with an int for the command number.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 745 of file job.cpp.

StatJob * KIO::stat	(	const KUrl &	url,
		JobFlags	flags = `DefaultFlags`
	)

Find all details for one file or directory.

Parameters

url	the URL of the file
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 924 of file job.cpp.

StatJob * KIO::stat	(	const KUrl &	url,
		KIO::StatJob::StatSide	side,
		short int	details,
		JobFlags	flags = `DefaultFlags`
	)

Find all details for one file or directory.

This version of the call includes two additional booleans, sideIsSource and details.

Parameters

url	the URL of the file
side	is SourceSide when stating a source file (we will do a get on it if the stat works) and DestinationSide when stating a destination file (target of a copy). The reason for this parameter is that in some cases the kioslave might not be able to determine a file's existence (e.g. HTTP doesn't allow it, FTP has issues with case-sensitivity on some systems). When the slave can't reliably determine the existence of a file, it will: be optimistic if SourceSide, i.e. it will assume the file exists, and if it doesn't this will appear when actually trying to download it be pessimistic if DestinationSide, i.e. it will assume the file doesn't exist, to prevent showing "about to overwrite" errors to the user. If you simply want to check for existence without downloading/uploading afterwards, then you should use DestinationSide.
details	selects the level of details we want. By default this is 2 (all details wanted, including modification time, size, etc.), setDetails(1) is used when deleting: we don't need all the information if it takes too much time, no need to follow symlinks etc. setDetails(0) is used for very simple probing: we'll only get the answer "it's a file or a directory or a symlink, or it doesn't exist". This is used by KRun and DeleteJob.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 952 of file job.cpp.

StatJob * KIO::stat	(	const KUrl &	url,
		bool	sideIsSource,
		short int	details,
		JobFlags	flags = `DefaultFlags`
	)

Find all details for one file or directory.

This version of the call includes two additional booleans, sideIsSource and details.

Parameters

url	the URL of the file
sideIsSource	is true when stating a source file (we will do a get on it if the stat works) and false when stating a destination file (target of a copy). The reason for this parameter is that in some cases the kioslave might not be able to determine a file's existence (e.g. HTTP doesn't allow it, FTP has issues with case-sensitivity on some systems). When the slave can't reliably determine the existence of a file, it will: be optimistic if sideIsSource=true, i.e. it will assume the file exists, and if it doesn't this will appear when actually trying to download it be pessimistic if sideIsSource=false, i.e. it will assume the file doesn't exist, to prevent showing "about to overwrite" errors to the user. If you simply want to check for existence without downloading/uploading afterwards, then you should use sideIsSource=false.
details	selects the level of details we want. By default this is 2 (all details wanted, including modification time, size, etc.), setDetails(1) is used when deleting: we don't need all the information if it takes too much time, no need to follow symlinks etc. setDetails(0) is used for very simple probing: we'll only get the answer "it's a file or a directory, or it doesn't exist". This is used by KRun.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 941 of file job.cpp.

StoredTransferJob * KIO::storedGet	(	const KUrl &	url,
		LoadType	reload = `NoReload`,
		JobFlags	flags = `DefaultFlags`
	)

Get (a.k.a.

read), into a single QByteArray.

See also: StoredTransferJob

Parameters

url	the URL of the file
reload	Reload to reload the file, NoReload if it can be taken from the cache
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 1766 of file job.cpp.

StoredTransferJob * KIO::storedHttpPost	(	const QByteArray &	arr,
		const KUrl &	url,
		JobFlags	flags = `DefaultFlags`
	)

HTTP POST (a.k.a.

write) data from a single QByteArray.

See also: StoredTransferJob

Parameters

arr	The data to write
url	Where to write data.
flags	Can be HideProgressInfo here.

Returns: the job handling the operation.

Since: 4.2

Definition at line 1646 of file job.cpp.

StoredTransferJob * KIO::storedHttpPost	(	QIODevice *	device,
		const KUrl &	url,
		qint64	size = `-1`,
		JobFlags	flags = `DefaultFlags`
	)

HTTP POST (a.k.a.

write) data from the given IO device.

See also: StoredTransferJob

Parameters

device	Device from which the encoded data to be posted is read.
url	Where to write data.
size	Size of the encoded data to be posted.
flags	Can be HideProgressInfo here.

Returns: the job handling the operation.

Since: 4.7

Definition at line 1664 of file job.cpp.

StoredTransferJob * KIO::storedPut	(	const QByteArray &	arr,
		const KUrl &	url,
		int	permissions,
		JobFlags	flags = `DefaultFlags`
	)

Put (a.k.a.

write) data from a single QByteArray.

See also: StoredTransferJob

Parameters

arr	The data to write
url	Where to write data.
permissions	May be -1. In this case no special permission mode is set.
flags	Can be HideProgressInfo, Overwrite and Resume here. WARNING: Setting Resume means that the data will be appended to `dest` if `dest` exists.

Returns: the job handling the operation.

Definition at line 1776 of file job.cpp.

SimpleJob * KIO::symlink	(	const QString &	target,
		const KUrl &	dest,
		JobFlags	flags = `DefaultFlags`
	)

Create or move a symlink.

This is the lowlevel operation, similar to file_copy and file_move. It doesn't do any check (other than those the slave does) and it doesn't show rename and skip dialogs - use KIO::link for that.

Parameters

target	The string that will become the "target" of the link (can be relative)
dest	The symlink to create.
flags	Can be Overwrite and HideProgressInfo

Returns: the job handling the operation.

Definition at line 738 of file job.cpp.

CopyJob * KIO::trash	(	const KUrl &	src,
		JobFlags	flags = `DefaultFlags`
	)

Trash a file or directory.

This is currently only supported for local files and directories. Use "KUrl src; src.setPath( path );" to create a URL from a path.

Parameters

src	file to delete
flags	trash() supports HideProgressInfo only

Returns: the job handling the operation

Definition at line 2233 of file copyjob.cpp.

CopyJob * KIO::trash	(	const KUrl::List &	src,
		JobFlags	flags = `DefaultFlags`
	)

Trash a list of files or directories.

This is currently only supported for local files and directories.

Parameters

src	the files to delete
flags	trash() supports HideProgressInfo only

Returns: the job handling the operation

Definition at line 2240 of file copyjob.cpp.

SimpleJob * KIO::unmount	(	const QString &	point,
		JobFlags	flags = `DefaultFlags`
	)

Unmount filesystem.

Special job for kio_file.

Parameters

point	Point to unmount.
flags	Can be HideProgressInfo here

Returns: the job handling the operation.

Definition at line 762 of file job.cpp.

QString KIO::unsupportedActionErrorString	(	const QString &	protocol,
		int	cmd
	)

Returns an appropriate error message if the given command cmd is an unsupported action (ERR_UNSUPPORTED_ACTION).

Parameters

protocol	name of the protocol
cmd	given command

See also: enum Command

Definition at line 376 of file global.cpp.

Variable Documentation

const int KIO::switchIconInterval = 1000

static

Definition at line 183 of file delegateanimationhandler.cpp.

KIO

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation

KIO

kdelibs API Reference

Search