KIO Namespace Reference

A namespace for KIO globals. More...


Classes
class	AuthInfo
	This class is intended to make it easier to prompt for, cache and retrieve authorization information. More...
class	ChmodJob
	This job changes permissions on a list of files or directories, optionally in a recursive manner. More...
class	Connection
	This class provides a simple means for IPC between two applications via a pipe. More...
struct	CopyInfo
class	CopyJob
	CopyJob is used to move, copy or symlink files and directories. More...
class	DataProtocol
	This kioslave provides support of data urls as specified by rfc 2397. More...
class	DataSlave
	This class provides a high performance implementation for the data url scheme (rfc2397). More...
class	DavJob
	The transfer job pumps data into and/or out of a Slave. More...
class	DefaultProgress
class	DeleteJob
	A more complex Job to delete files and directories. More...
class	DirectCopyJob
class	FileCopyJob
	The FileCopyJob copies data from one place to another. More...
class	ForwardingSlaveBase
	This class should be used as a base for ioslaves acting as a forwarder to other ioslaves. More...
class	Job
	The base class for all jobs. More...
class	ListJob
	A ListJob is allows you to get the get the content of a directory. More...
class	MetaData
	MetaData is a simple map of key/value strings. More...
class	MetaInfoJob
	MetaInfoJob is a KIO Job to retrieve meta information from files. More...
class	MimetypeJob
	A MimetypeJob is a TransferJob that allows you to get the mime type of an URL. More...
class	MkdirJob
	A KIO job that creates a directory. More...
class	MultiGetJob
	The MultiGetJob is a TransferJob that allows you to get several files from a single server. More...
class	NetAccess
	Net Transparency. More...
class	NetRC
	A Singleton class that provides access to passwords stored in .netrc files for automatic login purposes. More...
class	ParseContext
class	ParseTreeAND
class	ParseTreeBase
class	ParseTreeBOOL
class	ParseTreeBRACKETS
class	ParseTreeCALC
class	ParseTreeCMP
class	ParseTreeDOUBLE
class	ParseTreeEXIST
class	ParseTreeID
class	ParseTreeIN
class	ParseTreeMATCH
class	ParseTreeMAX2
class	ParseTreeMIN2
class	ParseTreeNOT
class	ParseTreeNUM
class	ParseTreeOR
class	ParseTreeSTRING
class	PasswordDialog
	A dialog for requesting a login and a password from the end user. More...
class	PasteDialog
struct	PreferencesMaxima
struct	PreferencesReturn
class	PreviewJob
	KIO Job to get a thumbnail picture. More...
class	ProgressBase
	This class does all initialization stuff for progress, like connecting signals to slots. More...
class	RenameDlg
	A dialog for the options to rename two files. More...
class	Scheduler
	The KIO::Scheduler manages io-slaves for the application. More...
class	SessionData
class	SimpleJob
	A simple job (one url and one command). More...
class	SkipDlg
class	Slave
	Attention developers: If you change the implementation of KIO::Slave, do not use connection() or slaveconn but the respective KIO::Slave accessor methods. More...
class	SlaveBase
	There are two classes that specifies the protocol between application (job) and kioslave. More...
class	SlaveConfig
	SlaveConfig. More...
class	SlaveInterface
	There are two classes that specifies the protocol between application (KIO::Job) and kioslave. More...
class	StatJob
	A KIO job that retrieves information about a file or directory. More...
class	StatusbarProgress
	This is a special IO progress widget. More...
class	StoredTransferJob
	StoredTransferJob is a TransferJob (for downloading or uploading data) that also stores a QByteArray with the data, making it simpler to use than the standard TransferJob. More...
struct	Task
class	TCPSlaveBase
	There are two classes that specifies the protocol between application (job) and kioslave. More...
class	TransferJob
	The transfer job pumps data into and/or out of a Slave. More...
class	UDSAtom
Typedefs
typedef Q_LLONG	fileoffset_t
typedef Q_ULLONG	filesize_t
typedef QValueList< UDSAtom >	UDSEntry
typedef QValueList< UDSEntry >	UDSEntryList
typedef QValueListConstIterator < UDSEntry >	UDSEntryListConstIterator
typedef QValueListIterator < UDSEntry >	UDSEntryListIterator
Enumerations
enum	CacheControl { CC_CacheOnly, CC_Cache, CC_Verify, CC_Refresh, CC_Reload }
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_USERPASS = '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' }
enum	Error { ERR_CANNOT_OPEN_FOR_READING = 1, ERR_CANNOT_OPEN_FOR_WRITING = 2, ERR_CANNOT_LAUNCH_PROCESS = 3, ERR_INTERNAL = 4, ERR_MALFORMED_URL = 5, ERR_UNSUPPORTED_PROTOCOL = 6, ERR_NO_SOURCE_PROTOCOL = 7, ERR_UNSUPPORTED_ACTION = 8, ERR_IS_DIRECTORY = 9, ERR_IS_FILE = 10, ERR_DOES_NOT_EXIST = 11, ERR_FILE_ALREADY_EXIST = 12, ERR_DIR_ALREADY_EXIST = 13, ERR_UNKNOWN_HOST = 14, ERR_ACCESS_DENIED = 15, ERR_WRITE_ACCESS_DENIED = 16, ERR_CANNOT_ENTER_DIRECTORY = 17, ERR_PROTOCOL_IS_NOT_A_FILESYSTEM = 18, ERR_CYCLIC_LINK = 19, ERR_USER_CANCELED = 20, ERR_CYCLIC_COPY = 21, ERR_COULD_NOT_CREATE_SOCKET = 22, ERR_COULD_NOT_CONNECT = 23, ERR_CONNECTION_BROKEN = 24, ERR_NOT_FILTER_PROTOCOL = 25, ERR_COULD_NOT_MOUNT = 26, ERR_COULD_NOT_UNMOUNT = 27, ERR_COULD_NOT_READ = 28, ERR_COULD_NOT_WRITE = 29, ERR_COULD_NOT_BIND = 30, ERR_COULD_NOT_LISTEN = 31, ERR_COULD_NOT_ACCEPT = 32, ERR_COULD_NOT_LOGIN = 33, ERR_COULD_NOT_STAT = 34, ERR_COULD_NOT_CLOSEDIR = 35, ERR_COULD_NOT_MKDIR = 37, ERR_COULD_NOT_RMDIR = 38, ERR_CANNOT_RESUME = 39, ERR_CANNOT_RENAME = 40, ERR_CANNOT_CHMOD = 41, ERR_CANNOT_DELETE = 42, ERR_SLAVE_DIED = 43, ERR_OUT_OF_MEMORY = 44, ERR_UNKNOWN_PROXY_HOST = 45, ERR_COULD_NOT_AUTHENTICATE = 46, ERR_ABORTED = 47, ERR_INTERNAL_SERVER = 48, ERR_SERVER_TIMEOUT = 49, ERR_SERVICE_NOT_AVAILABLE = 50, ERR_UNKNOWN = 51, ERR_UNKNOWN_INTERRUPT = 53, ERR_CANNOT_DELETE_ORIGINAL = 54, ERR_CANNOT_DELETE_PARTIAL = 55, ERR_CANNOT_RENAME_ORIGINAL = 56, ERR_CANNOT_RENAME_PARTIAL = 57, ERR_NEED_PASSWD = 58, ERR_CANNOT_SYMLINK = 59, ERR_NO_CONTENT = 60, ERR_DISK_FULL = 61, ERR_IDENTICAL_FILES = 62, ERR_SLAVE_DEFINED = 63, ERR_UPGRADE_REQUIRED = 64, ERR_POST_DENIED = 65 }
enum	FileSystemFlag { SupportsChmod, SupportsChown, SupportsUTime, SupportsSymlinks, CaseInsensitive }
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_NEED_PASSWD = 25, INF_INFOMESSAGE, INF_META_DATA, INF_NETWORK_STATUS, INF_MESSAGEBOX }
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 }
enum	Progress { DEFAULT = 1, STATUSBAR = 2, LIST = 3 }
enum	RenameDlg_Mode { M_OVERWRITE = 1, M_OVERWRITE_ITSELF = 2, M_SKIP = 4, M_SINGLE = 8, M_MULTI = 16, M_RESUME = 32, M_NORENAME = 64 }
enum	RenameDlg_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_CANCEL = 0 }
enum	SkipDlg_Result { S_SKIP = 1, S_AUTO_SKIP = 2, S_CANCEL = 0 }
enum	UDSAtomTypes { UDS_STRING = 1, UDS_LONG = 2, UDS_TIME = 4 \| UDS_LONG, UDS_SIZE = 8 \| UDS_LONG, UDS_SIZE_LARGE = 32768 \| UDS_LONG, UDS_USER = 16 \| UDS_STRING, UDS_ICON_NAME = 24 \| UDS_STRING, UDS_GROUP = 32 \| UDS_STRING, UDS_EXTRA = 48 \| UDS_STRING, UDS_NAME = 64 \| UDS_STRING, UDS_LOCAL_PATH = 72 \| UDS_STRING, UDS_HIDDEN = 80 \| UDS_LONG, UDS_EXTENDED_ACL = 88 \| UDS_LONG, UDS_ACL_STRING = 96 \| UDS_STRING, UDS_DEFAULT_ACL_STRING = 104 \| UDS_STRING, UDS_ACCESS = 128 \| UDS_LONG, UDS_MODIFICATION_TIME = 256 \| UDS_TIME, UDS_ACCESS_TIME = 512 \| UDS_TIME, UDS_CREATION_TIME = 1024 \| UDS_TIME, UDS_FILE_TYPE = 2048 \| UDS_LONG, UDS_LINK_DEST = 4096 \| UDS_STRING, UDS_URL = 8192 \| UDS_STRING, UDS_MIME_TYPE = 16384 \| UDS_STRING, UDS_GUESSED_MIME_TYPE = 16392 \| UDS_STRING, UDS_XML_PROPERTIES = 0x8000 \| UDS_STRING }
Functions
KIO_EXPORT QString	buildErrorString (int errorCode, const QString &errorText)
KIO_EXPORT QString	buildHTMLErrorString (int errorCode, const QString &errorText, const KURL *reqUrl=0L, int method=-1)
KIO_EXPORT QTime	calculateRemaining (KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed) KDE_DEPRECATED
KIO_EXPORT unsigned int	calculateRemainingSeconds (KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed)
KIO_EXPORT SimpleJob *	chmod (const KURL &url, int permissions)
KIO_EXPORT ChmodJob *	chmod (const KFileItemList &lstItems, int permissions, int mask, QString newOwner, QString newGroup, bool recursive, bool showProgressInfo=true)
KIO_EXPORT QString	convertSeconds (unsigned int seconds)
KIO_EXPORT QString	convertSize (KIO::filesize_t size)
KIO_EXPORT QString	convertSizeFromKB (KIO::filesize_t kbSize)
KIO_EXPORT QString	convertSizeWithBytes (KIO::filesize_t size)
KIO_EXPORT CopyJob *	copy (const KURL::List &src, const KURL &dest, bool showProgressInfo=true)
KIO_EXPORT CopyJob *	copy (const KURL &src, const KURL &dest, bool showProgressInfo=true)
KIO_EXPORT CopyJob *	copyAs (const KURL &src, const KURL &dest, bool showProgressInfo=true)
KIO_EXPORT DavJob *	davPropFind (const KURL &url, const QDomDocument &properties, QString depth, bool showProgressInfo=true)
KIO_EXPORT DavJob *	davPropPatch (const KURL &url, const QDomDocument &properties, bool showProgressInfo=true)
KIO_EXPORT DavJob *	davSearch (const KURL &url, const QString &nsURI, const QString &qName, const QString &query, bool showProgressInfo=true)
KIO_EXPORT QString	decodeFileName (const QString &str)
KIO_EXPORT DeleteJob *	del (const KURL::List &src, bool shred=false, bool showProgressInfo=true)
KIO_EXPORT DeleteJob *	del (const KURL &src, bool shred=false, bool showProgressInfo=true)
KIO_EXPORT QString	encodeFileName (const QString &str)
KIO_EXPORT FileCopyJob *	file_copy (const KURL &src, const KURL &dest, int permissions=-1, bool overwrite=false, bool resume=false, bool showProgressInfo=true)
KIO_EXPORT SimpleJob *	file_delete (const KURL &src, bool showProgressInfo=true)
KIO_EXPORT FileCopyJob *	file_move (const KURL &src, const KURL &dest, int permissions=-1, bool overwrite=false, bool resume=false, bool showProgressInfo=true)
KIO_EXPORT MetaInfoJob *	fileMetaInfo (const KURL::List &items)
KIO_EXPORT MetaInfoJob *	fileMetaInfo (const KFileItemList &items)
KIO_EXPORT 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)
KIO_EXPORT 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)
KIO_EXPORT QString	findDeviceMountPoint (const QString &device)
KIO_EXPORT QString	findPathMountPoint (const QString &filename)
KIO_EXPORT TransferJob *	get (const KURL &url, bool reload=false, bool showProgressInfo=true)
KIO_EXPORT QString	getCacheControlString (KIO::CacheControl cacheControl)
KIO_EXPORT TransferJob *	http_post (const KURL &url, const QByteArray &postData, bool showProgressInfo=true)
KIO_EXPORT SimpleJob *	http_update_cache (const KURL &url, bool no_cache, time_t expireDate)
KIO_EXPORT_DEPRECATED bool	isClipboardEmpty ()
KIO_EXPORT QString	itemsSummaryString (uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize)
KIO_EXPORT CopyJob *	link (const KURL::List &src, const KURL &destDir, bool showProgressInfo=true)
KIO_EXPORT CopyJob *	link (const KURL &src, const KURL &destDir, bool showProgressInfo=true)
KIO_EXPORT CopyJob *	linkAs (const KURL &src, const KURL &dest, bool showProgressInfo=true)
KIO_EXPORT ListJob *	listDir (const KURL &url, bool showProgressInfo=true, bool includeHidden=true)
KIO_EXPORT ListJob *	listRecursive (const KURL &url, bool showProgressInfo=true, bool includeHidden=true)
KIO_EXPORT bool	manually_mounted (const QString &filename)
int	matchConstraint (const ParseTreeBase *_tree, const KService::Ptr &, const KServiceTypeProfile::OfferList &)
PreferencesReturn	matchPreferences (const ParseTreeBase *_tree, const KService::Ptr &, const KServiceTypeProfile::OfferList &)
KIO_EXPORT MimetypeJob *	mimetype (const KURL &url, bool showProgressInfo=true)
KIO_EXPORT SimpleJob *	mkdir (const KURL &url, int permissions=-1)
KIO_EXPORT SimpleJob *	mount (bool ro, const char *fstype, const QString &dev, const QString &point, bool showProgressInfo=true)
KIO_EXPORT CopyJob *	move (const KURL::List &src, const KURL &dest, bool showProgressInfo=true)
KIO_EXPORT CopyJob *	move (const KURL &src, const KURL &dest, bool showProgressInfo=true)
KIO_EXPORT CopyJob *	moveAs (const KURL &src, const KURL &dest, bool showProgressInfo=true)
KIO_EXPORT MultiGetJob *	multi_get (long id, const KURL &url, const MetaData &metaData)
KIO_EXPORT QString	number (KIO::filesize_t size)
KIO_EXPORT RenameDlg_Result	open_RenameDlg (const QString &caption, const QString &src, const QString &dest, RenameDlg_Mode mode, QString &newDestPath, 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)
KIO_EXPORT SkipDlg_Result	open_SkipDlg (bool _multi, const QString &_error_text=QString::null)
KIO_EXPORT QDataStream &	operator<< (QDataStream &s, const AuthInfo &a)
KIO_EXPORT QDataStream &	operator>> (QDataStream &s, AuthInfo &a)
KIO_EXPORT KIO::CacheControl	parseCacheControl (const QString &cacheControl)
KIO_EXPORT ParseTreeBase::Ptr	parseConstraints (const QString &_constr)
KIO_EXPORT ParseTreeBase::Ptr	parsePreferences (const QString &_prefs)
KIO_EXPORT QString	pasteActionText ()
KIO_EXPORT Job *	pasteClipboard (const KURL &destURL, bool move=false)
KIO_EXPORT void	pasteData (const KURL &destURL, const QByteArray &data)
KIO_EXPORT CopyJob *	pasteDataAsync (const KURL &destURL, const QByteArray &data, const QString &dialogText)
KIO_EXPORT CopyJob *	pasteDataAsync (const KURL &destURL, const QByteArray &data)
KIO_EXPORT CopyJob *	pasteMimeSource (QMimeSource data, const KURL &destURL, const QString &dialogText, QWidget widget, bool clipboard=false)
KIO_EXPORT bool	probably_slow_mounted (const QString &filename)
KIO_EXPORT TransferJob *	put (const KURL &url, int permissions, bool overwrite, bool resume, bool showProgressInfo=true)
KIO_EXPORT QByteArray	rawErrorDetail (int errorCode, const QString &errorText, const KURL *reqUrl=0L, int method=-1)
static void	readConfig (KConfig config, const QString &group, MetaData metaData)
KIO_EXPORT SimpleJob *	rename (const KURL &src, const KURL &dest, bool overwrite)
KIO_EXPORT SimpleJob *	rmdir (const KURL &url)
KIO_EXPORT SimpleJob *	special (const KURL &url, const QByteArray &data, bool showProgressInfo=true)
KIO_EXPORT StatJob *	stat (const KURL &url, bool sideIsSource, short int details, bool showProgressInfo=true)
KIO_EXPORT StatJob *	stat (const KURL &url, bool showProgressInfo=true)
KIO_EXPORT StoredTransferJob *	storedGet (const KURL &url, bool reload=false, bool showProgressInfo=true)
KIO_EXPORT StoredTransferJob *	storedPut (const QByteArray &arr, const KURL &url, int permissions, bool overwrite, bool resume, bool showProgressInfo=true)
KIO_EXPORT SimpleJob *	symlink (const QString &target, const KURL &dest, bool overwrite, bool showProgressInfo=true)
KIO_EXPORT bool	testFileSystemFlag (const QString &filename, FileSystemFlag flag)
KIO_EXPORT CopyJob *	trash (const KURL::List &src, bool showProgressInfo=true)
KIO_EXPORT CopyJob *	trash (const KURL &src, bool showProgressInfo=true)
KIO_EXPORT SimpleJob *	unmount (const QString &point, bool showProgressInfo=true)
KIO_EXPORT QString	unsupportedActionErrorString (const QString &protocol, int cmd)
Variables
static KStaticDeleter < SlaveConfig >	slaveconfigsd

Detailed Description

A namespace for KIO globals.

Typedef Documentation

typedef Q_LLONG KIO::fileoffset_t

64-bit file offset

Definition at line 37 of file global.h.

typedef Q_ULLONG KIO::filesize_t

64-bit file size

Definition at line 39 of file global.h.

typedef QValueList<UDSAtom> KIO::UDSEntry

An entry is the list of atoms containing all the informations for a file or URL.

Definition at line 504 of file global.h.

typedef QValueList<UDSEntry> KIO::UDSEntryList

Definition at line 505 of file global.h.

typedef QValueListConstIterator<UDSEntry> KIO::UDSEntryListConstIterator

Definition at line 507 of file global.h.

typedef QValueListIterator<UDSEntry> KIO::UDSEntryListIterator

Definition at line 506 of file global.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. Since: 3.1
CC_Reload	Always fetch from remote site.

Definition at line 384 of file global.h.

enum KIO::Command

Commands that can be invoked by a job.

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_USERPASS
CMD_REPARSECONFIGURATION
CMD_META_DATA
CMD_SYMLINK
CMD_SUBURL
CMD_MESSAGEBOXANSWER
CMD_RESUMEANSWER
CMD_CONFIG
CMD_MULTI_GET

Definition at line 138 of file global.h.

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

Definition at line 174 of file global.h.

enum KIO::FileSystemFlag

Enumerator:

SupportsChmod
SupportsChown
SupportsUTime
SupportsSymlinks
CaseInsensitive

Definition at line 445 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_NEED_PASSWD
INF_INFOMESSAGE
INF_META_DATA
INF_NETWORK_STATUS
INF_MESSAGEBOX

Definition at line 44 of file slaveinterface.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

Definition at line 64 of file slaveinterface.h.

enum KIO::Progress

Enumerator:

DEFAULT
STATUSBAR
LIST

Definition at line 35 of file progressbase.h.

enum KIO::RenameDlg_Mode

Enumerator:

M_OVERWRITE
M_OVERWRITE_ITSELF
M_SKIP
M_SINGLE
M_MULTI
M_RESUME
M_NORENAME

Definition at line 35 of file renamedlg.h.

enum KIO::RenameDlg_Result

The result of open_RenameDlg().

Enumerator:

R_RESUME
R_RESUME_ALL
R_OVERWRITE
R_OVERWRITE_ALL
R_SKIP
R_AUTO_SKIP
R_RENAME
R_CANCEL

Definition at line 40 of file renamedlg.h.

enum KIO::SkipDlg_Result

Enumerator:

S_SKIP
S_AUTO_SKIP
S_CANCEL

Definition at line 30 of file skipdlg.h.

enum KIO::UDSAtomTypes

Constants used to specify the type of a KUDSAtom.

Enumerator:

UDS_STRING	First let's define the item types.
UDS_LONG
UDS_TIME
UDS_SIZE	Size of the file.
UDS_SIZE_LARGE
UDS_USER	User ID of the file owner.
UDS_ICON_NAME	Name of the icon, that should be used for displaying. It overrides all other detection mechanisms Since: 3.2
UDS_GROUP	Group ID of the file owner.
UDS_EXTRA	Extra data (used only if you specified Columns/ColumnsTypes) This is the only UDS entry that can be repeated. Since: 3.2
UDS_NAME	Filename - as displayed in directory listings etc. "." has the usual special meaning of "current directory"
UDS_LOCAL_PATH	A local file path if the ioslave display files sitting on the local filesystem (but in another hierarchy, e.g. media:/)
UDS_HIDDEN	Treat the file as a hidden file or as a normal file, regardless of (the absence of) a leading dot in the filename.
UDS_EXTENDED_ACL	Indicates that the entry has extended ACL entries. Since: 3.5
UDS_ACL_STRING	The access control list serialized into a single string. Since: 3.5
UDS_DEFAULT_ACL_STRING	The default access control list serialized into a single string. Only available for directories. Since: 3.5
UDS_ACCESS	Access permissions (part of the mode returned by stat).
UDS_MODIFICATION_TIME	The last time the file was modified.
UDS_ACCESS_TIME	The last time the file was opened.
UDS_CREATION_TIME	The time the file was created.
UDS_FILE_TYPE	File type, part of the mode returned by stat (for a link, this returns the file type of the pointed item) check UDS_LINK_DEST to know if this is a link.
UDS_LINK_DEST	Name of the file where the link points to Allows to check for a symlink (don't use S_ISLNK !).
UDS_URL	An alternative URL (If different from the caption).
UDS_MIME_TYPE	A mime type; prevents guessing.
UDS_GUESSED_MIME_TYPE	A mime type to be used for displaying only. But when 'running' the file, the mimetype is re-determined
UDS_XML_PROPERTIES	XML properties, e.g. for WebDAV Since: 3.1

Definition at line 305 of file global.h.

Function Documentation

KIO_EXPORT 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 213 of file global.cpp.

KIO_EXPORT 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

KIO_EXPORT 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 127 of file global.cpp.

KIO_EXPORT 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

Since:: 3.4

Definition at line 103 of file global.cpp.

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

Changes permissions on a file or directory.

See the other chmod below 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 765 of file job.cpp.

KIO_EXPORT ChmodJob * KIO::chmod	(	const KFileItemList &	lstItems,
		int	permissions,
		int	mask,
		QString	newOwner,
		QString	newGroup,
		bool	recursive,
		bool	showProgressInfo = `true`
	)

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
	showProgressInfo	true to show progess information

Returns:: The job handling the operation.

Definition at line 230 of file chmodjob.cpp.

KIO_EXPORT 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

Since:: 3.4

Definition at line 112 of file global.cpp.

KIO_EXPORT 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 kB , 12.0 MB

Definition at line 53 of file global.cpp.

KIO_EXPORT QString KIO::convertSizeFromKB ( KIO::filesize_t kbSize )

Converts size from kilo-bytes to the string representation.

Parameters:

kbSize

size in kilo-bytes

Returns:: converted size as a string - e.g. 123.4 kB , 12.0 MB

Definition at line 91 of file global.cpp.

KIO_EXPORT QString KIO::convertSizeWithBytes ( KIO::filesize_t size )

Converts size from bytes to a string representation with includes the size in bytes.

e.g. 90 B, 240 B, 1.4 KB (1495 B), 2.6MB (2,734,344 B), 0 B

Parameters:

size

size in bytes

Returns:: converted size as a string - e.g. 1.4 KB (1495 B), 45 B

Definition at line 45 of file global.cpp.

CopyJob * KIO::copy	(	const KURL::List &	src,
		const KURL &	dest,
		bool	showProgressInfo = `true`
	)

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

Parameters:

	src	the list of files and/or directories
	dest	the destination
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

Definition at line 3902 of file job.cpp.

CopyJob * KIO::copy	(	const KURL &	src,
		const KURL &	dest,
		bool	showProgressInfo = `true`
	)

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
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

See also:: copyAs()

Definition at line 3886 of file job.cpp.

CopyJob * KIO::copyAs	(	const KURL &	src,
		const KURL &	dest,
		bool	showProgressInfo = `true`
	)

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.

Parameters:

	src	the file or directory to copy
	dest	the destination
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

Definition at line 3894 of file job.cpp.

DavJob * KIO::davPropFind	(	const KURL &	url,
		const QDomDocument &	properties,
		QString	depth,
		bool	showProgressInfo = `true`
	)

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"
	showProgressInfo	true to show progress information

Returns:: the new DavJob

Definition at line 117 of file davjob.cpp.

DavJob * KIO::davPropPatch	(	const KURL &	url,
		const QDomDocument &	properties,
		bool	showProgressInfo = `true`
	)

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
	showProgressInfo	true to show progress information

Returns:: the new DavJob

Definition at line 125 of file davjob.cpp.

DavJob * KIO::davSearch	(	const KURL &	url,
		const QString &	nsURI,
		const QString &	qName,
		const QString &	query,
		bool	showProgressInfo = `true`
	)

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
	showProgressInfo	true to show progress information

Returns:: the new DavJob

Definition at line 130 of file davjob.cpp.

KIO_EXPORT QString KIO::decodeFileName ( const QString & str )

Decodes (from the filename to the text displayed) This translates 2[fF] into / and %% into %.

Parameters:

str

the file name to decode

Returns:: the decoded file name

Definition at line 180 of file global.cpp.

DeleteJob * KIO::del	(	const KURL::List &	src,
		bool	shred = `false`,
		bool	showProgressInfo = `true`
	)

Deletes a list of files or directories.

Parameters:

	src	the files to delete
	shred	obsolete (TODO remove in KDE4)
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

Definition at line 4394 of file job.cpp.

DeleteJob * KIO::del	(	const KURL &	src,
		bool	shred = `false`,
		bool	showProgressInfo = `true`
	)

Delete a file or directory.

Parameters:

	src	file to delete
	shred	obsolete (TODO remove in KDE4)
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

Definition at line 4386 of file job.cpp.

KIO_EXPORT QString KIO::encodeFileName ( const QString & str )

Encodes (from the text displayed to the real filename) This translates % into %% and / into 2f Used by KIO::link, for instance.

Parameters:

str

the file name to encode

Returns:: the encoded file name

Definition at line 165 of file global.cpp.

FileCopyJob * KIO::file_copy	(	const KURL &	src,
		const KURL &	dest,
		int	permissions = `-1`,
		bool	overwrite = `false`,
		bool	resume = `false`,
		bool	showProgressInfo = `true`
	)

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.
	overwrite	If true, any existing file will be overwritten.
	resume	true to resume an operation. Warning, setting this to true means that `src` will be appended to `dest` if `dest` exists. You probably don't want that, so leave it to false :)
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 1963 of file job.cpp.

SimpleJob * KIO::file_delete	(	const KURL &	src,
		bool	showProgressInfo = `true`
	)

Delete a single file.

Parameters:

	src	File to delete.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 1975 of file job.cpp.

FileCopyJob * KIO::file_move	(	const KURL &	src,
		const KURL &	dest,
		int	permissions = `-1`,
		bool	overwrite = `false`,
		bool	resume = `false`,
		bool	showProgressInfo = `true`
	)

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.
	overwrite	If `true`, any existing file will be overwritten.
	resume	true to resume an operation. Warning, setting this to true means that `src` will be appended to `dest` if `dest` exists. You probably don't want that, so leave it to false :)
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 1969 of file job.cpp.

KIO_EXPORT 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

Definition at line 177 of file metainfojob.cpp.

KIO_EXPORT 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

Definition at line 172 of file metainfojob.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()

Definition at line 577 of file previewjob.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()

Definition at line 569 of file previewjob.cpp.

QString KIO::findDeviceMountPoint ( const QString & device )

Returns the mount point where device is mounted right now.

This means, it has to be mounted, not just defined in fstab.

Definition at line 1368 of file global.cpp.

QString KIO::findPathMountPoint ( const QString & filename )

Returns the mount point on which resides filename.

For instance if /home is a separate partition, findPathMountPoint("/home/user/blah") will return /home

Parameters:

filename

the file name to check

Returns:: the mount point of the given filename

Definition at line 1915 of file global.cpp.

TransferJob * KIO::get	(	const KURL &	url,
		bool	reload = `false`,
		bool	showProgressInfo = `true`
	)

Get (a.k.a.

read).

The slave emits the data through data().

Parameters:

	url	the URL of the file
	reload	true to reload the file, false if it can be taken from the cache
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 1220 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 1992 of file global.cpp.

TransferJob * KIO::http_post	(	const KURL &	url,
		const QByteArray &	postData,
		bool	showProgressInfo = `true`
	)

HTTP POST (for form data).

Example:

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

postData is the data that you want to send and contentType is the complete HTTP header line that specifies the content's MIME type, for example "Content-Type: text/xml".

You MUST specify content-type!

Often contentType is "Content-Type: application/x-www-form-urlencoded" and the postData is then an ASCII string (without null-termination!) with characters like space, linefeed and percent escaped like 20, 0A and 25.

Parameters:

	url	Where to write the data.
	postData	Encoded data to post.
	showProgressInfo	true to display

Returns:: the job handling the operation.

Definition at line 1243 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 904 of file job.cpp.

KIO_EXPORT bool KIO::isClipboardEmpty ( )

Checks whether the clipboard contains any URLs.

Returns:: true if not Not used anymore, wrong method name, so it will disappear in KDE4.

Definition at line 146 of file paste.cpp.

KIO_EXPORT 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 150 of file global.cpp.

CopyJob * KIO::link	(	const KURL::List &	src,
		const KURL &	destDir,
		bool	showProgressInfo = `true`
	)

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.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

See also:: link()

Definition at line 3937 of file job.cpp.

CopyJob * KIO::link	(	const KURL &	src,
		const KURL &	destDir,
		bool	showProgressInfo = `true`
	)

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.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

Definition at line 3930 of file job.cpp.

CopyJob * KIO::linkAs	(	const KURL &	src,
		const KURL &	dest,
		bool	showProgressInfo = `true`
	)

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.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

See also:: link ()
copyAs()

Definition at line 3942 of file job.cpp.

ListJob * KIO::listDir	(	const KURL &	url,
		bool	showProgressInfo = `true`,
		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
	showProgressInfo	true to show progress information
	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 2152 of file job.cpp.

ListJob * KIO::listRecursive	(	const KURL &	url,
		bool	showProgressInfo = `true`,
		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
	showProgressInfo	true to show progress information
	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 2158 of file job.cpp.

bool KIO::manually_mounted ( const QString & filename )

Checks if the path belongs to a filesystem that is manually mounted.

Parameters:

filename

the file name to check

Returns:: true if the filesystem is manually mounted

Definition at line 1926 of file global.cpp.

KIO_EXPORT int KIO::matchConstraint	(	const ParseTreeBase *	_tree,
		const KService::Ptr &	,
		const KServiceTypeProfile::OfferList &
	)

For internal use only.

Returns:: 0 => Does not match 1 => Does match <0 => Error

Definition at line 591 of file ktraderparsetree.cpp.

KIO_EXPORT PreferencesReturn KIO::matchPreferences	(	const ParseTreeBase *	_tree,
		const KService::Ptr &	,
		const KServiceTypeProfile::OfferList &
	)

For internal use only.

Returns:: 1 on success or <0 on Error

Definition at line 612 of file ktraderparsetree.cpp.

MimetypeJob * KIO::mimetype	(	const KURL &	url,
		bool	showProgressInfo = `true`
	)

Find mimetype for one file or directory.

Parameters:

	url	the URL of the file
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 1509 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 751 of file job.cpp.

SimpleJob * KIO::mount	(	bool	ro,
		const char *	fstype,
		const QString &	dev,
		const QString &	point,
		bool	showProgressInfo = `true`
	)

Mount filesystem.

Special job for kio_file.

Parameters:

	ro	Mount read-only if `true`.
	fstype	File system type (e.g. "ext2", can be 0L).
	dev	Device (e.g. /dev/sda0).
	point	Mount point, can be `null`.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 792 of file job.cpp.

CopyJob * KIO::move	(	const KURL::List &	src,
		const KURL &	dest,
		bool	showProgressInfo = `true`
	)

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
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

See also:: copy()

Definition at line 3924 of file job.cpp.

CopyJob * KIO::move	(	const KURL &	src,
		const KURL &	dest,
		bool	showProgressInfo = `true`
	)

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

Parameters:

	src	the file or directory to copy
	dest	the destination
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

See also:: copy()
moveAs()

Definition at line 3908 of file job.cpp.

CopyJob * KIO::moveAs	(	const KURL &	src,
		const KURL &	dest,
		bool	showProgressInfo = `true`
	)

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

Unlike move() this operation will fail when the directory already exists.

Parameters:

	src	the file or directory to copy
	dest	the destination
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

See also:: copyAs()

Definition at line 3916 of file job.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 4568 of file job.cpp.

KIO_EXPORT 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 96 of file global.cpp.

SkipDlg_Result KIO::open_SkipDlg	(	bool	_multi,
		const QString &	_error_text = `QString::null`
	)

Definition at line 135 of file skipdlg.cpp.

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

Definition at line 75 of file authinfo.cpp.

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

Definition at line 84 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 1973 of file global.cpp.

ParseTreeBase::Ptr KIO::parseConstraints ( const QString & _constr )

Definition at line 38 of file ktraderparse.cpp.

ParseTreeBase::Ptr KIO::parsePreferences ( const QString & _prefs )

Definition at line 48 of file ktraderparse.cpp.

KIO_EXPORT 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.

Since:: 3.5

Definition at line 291 of file paste.cpp.

KIO_EXPORT KIO::Job * KIO::pasteClipboard	(	const KURL &	destURL,
		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
	move	true to move the data, false to copy

Returns:: the job that handles the operation

See also:: pasteData()

Definition at line 210 of file paste.cpp.

KIO_EXPORT void KIO::pasteData	(	const KURL &	destURL,
		const QByteArray &	data
	)

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

See also:: pasteClipboard()

Definition at line 259 of file paste.cpp.

KIO_EXPORT KIO::CopyJob * KIO::pasteDataAsync	(	const KURL &	destURL,
		const QByteArray &	data,
		const QString &	dialogText
	)

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()

Definition at line 281 of file paste.cpp.

KIO_EXPORT KIO::CopyJob * KIO::pasteDataAsync	(	const KURL &	destURL,
		const QByteArray &	data
	)

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

See also:: pasteClipboard()

Definition at line 276 of file paste.cpp.

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

Save the given mimesource 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 kdesktop and konqueror.

Parameters:

	data	the QMimeSource (e.g. 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 QMimeSource comes from QClipboard. If you use pasteClipboard for that case, you never have to worry about this parameter.

See also:: pasteClipboard()

Since:: 3.5

Definition at line 164 of file paste.cpp.

bool KIO::probably_slow_mounted ( const QString & filename )

Checks if the path belongs to a filesystem that is probably slow.

It checks for NFS or for paths belonging to automounted paths not yet mounted

Parameters:

filename

the file name to check

Returns:: true if the filesystem is probably slow

Definition at line 1938 of file global.cpp.

TransferJob * KIO::put	(	const KURL &	url,
		int	permissions,
		bool	overwrite,
		bool	resume,
		bool	showProgressInfo = `true`
	)

Put (a.k.a.

write)

Parameters:

	url	Where to write data.
	permissions	May be -1. In this case no special permission mode is set.
	overwrite	If true, any existing file will be overwritten.
	resume	true to resume an operation. Warning, setting this to true means that the data will be appended to `dest` if `dest` exists.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

See also:: multi_get()

Definition at line 1380 of file job.cpp.

KIO_EXPORT 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 508 of file global.cpp.

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

Definition at line 53 of file slaveconfig.cpp.

SimpleJob * KIO::rename	(	const KURL &	src,
		const KURL &	dest,
		bool	overwrite
	)

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
	overwrite	whether to automatically overwrite if the dest exists

Returns:: the job handling the operation.

Definition at line 772 of file job.cpp.

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

Removes a single directory.

The directory is assumed to be empty.

Parameters:

url

The URL of the directory to remove.

Returns:: A pointer to the job handling the operation.

Definition at line 758 of file job.cpp.

SimpleJob * KIO::special	(	const KURL &	url,
		const QByteArray &	data,
		bool	showProgressInfo = `true`
	)

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.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 786 of file job.cpp.

StatJob * KIO::stat	(	const KURL &	url,
		bool	sideIsSource,
		short int	details,
		bool	showProgressInfo = `true`
	)

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.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 892 of file job.cpp.

StatJob * KIO::stat	(	const KURL &	url,
		bool	showProgressInfo = `true`
	)

Find all details for one file or directory.

Parameters:

	url	the URL of the file
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 886 of file job.cpp.

StoredTransferJob * KIO::storedGet	(	const KURL &	url,
		bool	reload = `false`,
		bool	showProgressInfo = `true`
	)

Get (a.k.a.

read), into a single QByteArray.

See also:: StoredTransferJob

Parameters:

	url	the URL of the file
	reload	true to reload the file, false if it can be taken from the cache
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Since:: 3.3

Definition at line 1441 of file job.cpp.

StoredTransferJob * KIO::storedPut	(	const QByteArray &	arr,
		const KURL &	url,
		int	permissions,
		bool	overwrite,
		bool	resume,
		bool	showProgressInfo = `true`
	)

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.
	overwrite	If true, any existing file will be overwritten.
	resume	true to resume an operation. Warning, setting this to true means that the data will be appended to `dest` if `dest` exists.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Since:: 3.3

Definition at line 1451 of file job.cpp.

SimpleJob * KIO::symlink	(	const QString &	target,
		const KURL &	dest,
		bool	overwrite,
		bool	showProgressInfo = `true`
	)

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.
	overwrite	whether to automatically overwrite if the dest exists
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 779 of file job.cpp.

bool KIO::testFileSystemFlag	(	const QString &	filename,
		FileSystemFlag	flag
	)

Checks the capabilities of the filesystem to which a given file belongs.

given feature (e.g. chmod).

Parameters:

	filename	the file name to check
	flag	the flag to check

Returns:: true if the filesystem has that flag, false if not (or some error occurred)

The availables flags are:

SupportsChmod: returns true if the filesystem supports chmod (e.g. msdos filesystems return false)
SupportsChown: returns true if the filesystem supports chown (e.g. msdos filesystems return false)
SupportsUtime: returns true if the filesystems supports utime (e.g. msdos filesystems return false)
SupportsSymlinks: returns true if the filesystems supports symlinks (e.g. msdos filesystems return false)
CaseInsensitive: returns true if the filesystem treats "foo" and "FOO" as being the same file (true for msdos systems)

Definition at line 1950 of file global.cpp.

CopyJob * KIO::trash	(	const KURL::List &	src,
		bool	showProgressInfo = `true`
	)

Trash a list of files or directories.

This is currently only supported for local files and directories.

Parameters:

	src	the files to delete
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

Since:: 3.4

Definition at line 3956 of file job.cpp.

CopyJob * KIO::trash	(	const KURL &	src,
		bool	showProgressInfo = `true`
	)

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
	showProgressInfo	true to show progress information

Returns:: the job handling the operation

Since:: 3.4

Definition at line 3949 of file job.cpp.

SimpleJob * KIO::unmount	(	const QString &	point,
		bool	showProgressInfo = `true`
	)

Unmount filesystem.

Special job for kio_file.

Parameters:

	point	Point to unmount.
	showProgressInfo	true to show progress information

Returns:: the job handling the operation.

Definition at line 802 of file job.cpp.

KIO_EXPORT 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

Since:: 3.2

Definition at line 419 of file global.cpp.

Variable Documentation

KStaticDeleter<SlaveConfig> KIO::slaveconfigsd [static]

Definition at line 137 of file slaveconfig.cpp.

kio

KIO Namespace Reference

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation

kio

API Reference