.TH "KIO" kde3 "11 Jun 2005" "Version Version 3.4.1" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO \- A namespace for KIO globals.  

.PP
.SH SYNOPSIS
.br
.PP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBAuthInfo\fP"
.br
.RI "\fIThis class is intended to make it easier to prompt for, cache and retrieve authorization information. A two way messaging class for passing authentication information. \fP"
.ti -1c
.RI "class \fBNetRC\fP"
.br
.RI "\fIA Singleton class that provides access to passwords stored in .netrc files for automatic login purposes. An interface to the ftp .netrc files. \fP"
.ti -1c
.RI "class \fBChmodJob\fP"
.br
.RI "\fIThis job changes permissions on a list of files or directories, optionally in a recursive manner. \fP"
.ti -1c
.RI "class \fBConnection\fP"
.br
.RI "\fIThis class provides a simple means for IPC between two applications via a pipe. \fP"
.ti -1c
.RI "class \fBDataProtocol\fP"
.br
.RI "\fIThis kioslave provides support of data urls as specified by rfc 2397. \fP"
.ti -1c
.RI "class \fBDataSlave\fP"
.br
.RI "\fIThis class provides a high performance implementation for the data url scheme (rfc2397). \fP"
.ti -1c
.RI "class \fBDavJob\fP"
.br
.RI "\fIThe transfer job pumps data into and/or out of a Slave. \fP"
.ti -1c
.RI "class \fBForwardingSlaveBase\fP"
.br
.RI "\fIThis class should be used as a base for ioslaves acting as a forwarder to other ioslaves. \fP"
.ti -1c
.RI "class \fBMetaData\fP"
.br
.RI "\fI\fBMetaData\fP is a simple map of key/value strings. \fP"
.ti -1c
.RI "class \fBJob\fP"
.br
.RI "\fIThe base class for all jobs. \fP"
.ti -1c
.RI "class \fBSimpleJob\fP"
.br
.RI "\fIA simple job (one url and one command). \fP"
.ti -1c
.RI "class \fBStatJob\fP"
.br
.RI "\fIA \fBKIO\fP job that retrieves information about a file or directory. \fP"
.ti -1c
.RI "class \fBMkdirJob\fP"
.br
.RI "\fIA \fBKIO\fP job that creates a directory. \fP"
.ti -1c
.RI "class \fBTransferJob\fP"
.br
.RI "\fIThe transfer job pumps data into and/or out of a Slave. \fP"
.ti -1c
.RI "class \fBStoredTransferJob\fP"
.br
.RI "\fI\fBStoredTransferJob\fP is a \fBTransferJob\fP (for downloading or uploading data) that also stores a \fBQByteArray\fP with the data, making it simpler to use than the standard \fBTransferJob\fP. \fP"
.ti -1c
.RI "class \fBMultiGetJob\fP"
.br
.RI "\fIThe \fBMultiGetJob\fP is a \fBTransferJob\fP that allows you to get several files from a single server. \fP"
.ti -1c
.RI "class \fBMimetypeJob\fP"
.br
.RI "\fIA \fBMimetypeJob\fP is a \fBTransferJob\fP that allows you to get the mime type of an URL. \fP"
.ti -1c
.RI "class \fBFileCopyJob\fP"
.br
.RI "\fIThe \fBFileCopyJob\fP copies data from one place to another. \fP"
.ti -1c
.RI "class \fBListJob\fP"
.br
.RI "\fIA \fBListJob\fP is allows you to get the get the content of a directory. \fP"
.ti -1c
.RI "class \fBCopyJob\fP"
.br
.RI "\fI\fBCopyJob\fP is used to move, copy or symlink files and directories. \fP"
.ti -1c
.RI "class \fBDeleteJob\fP"
.br
.RI "\fIA more complex \fBJob\fP to delete files and directories. \fP"
.ti -1c
.RI "class \fBMetaInfoJob\fP"
.br
.RI "\fI\fBMetaInfoJob\fP is a \fBKIO\fP \fBJob\fP to retrieve meta information from files. \fBKIO\fP \fBJob\fP to retrieve meta information from files. 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP
\fP"
.ti -1c
.RI "class \fBNetAccess\fP"
.br
.RI "\fINet Transparency. Provides an easy, synchronous interface to \fBKIO\fP file operations. \fP"
.ti -1c
.RI "class \fBPasswordDialog\fP"
.br
.RI "\fIA dialog for requesting a login and a password from the end user. dialog for requesting login and password from the end user. \fP"
.ti -1c
.RI "class \fBPreviewJob\fP"
.br
.RI "\fI\fBKIO\fP \fBJob\fP to get a thumbnail picture. \fP"
.ti -1c
.RI "class \fBProgressBase\fP"
.br
.RI "\fIThis class does all initialization stuff for progress, like connecting signals to slots. Base class for IO progress dialogs. \fP"
.ti -1c
.RI "class \fBRenameDlg\fP"
.br
.RI "\fIA dialog for the options to rename two files. A dialog for renaming files. 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP
\fP"
.ti -1c
.RI "class \fBScheduler\fP"
.br
.RI "\fIThe KIO::Scheduler manages io-slaves for the application. \fP"
.ti -1c
.RI "class \fBSlaveBase\fP"
.br
.RI "\fIThere are two classes that specifies the protocol between application (job) and kioslave. \fP"
.ti -1c
.RI "class \fBSlaveConfig\fP"
.br
.RI "\fI\fBSlaveConfig\fP. \fP"
.ti -1c
.RI "class \fBSlaveInterface\fP"
.br
.RI "\fIThere are two classes that specifies the protocol between application ( \fBKIO::Job\fP) and kioslave. \fP"
.ti -1c
.RI "class \fBStatusbarProgress\fP"
.br
.RI "\fIThis is a special IO progress widget. IO progress widget for embedding in a statusbar. \fP"
.ti -1c
.RI "class \fBTCPSlaveBase\fP"
.br
.RI "\fIThere are two classes that specifies the protocol between application (job) and kioslave. \fP"
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef Q_LLONG \fBfileoffset_t\fP"
.br
.ti -1c
.RI "typedef Q_ULLONG \fBfilesize_t\fP"
.br
.ti -1c
.RI "typedef \fBQValueList\fP< UDSAtom > \fBUDSEntry\fP"
.br
.ti -1c
.RI "typedef \fBQValueList\fP< \fBUDSEntry\fP > \fBUDSEntryList\fP"
.br
.ti -1c
.RI "typedef \fBQValueListIterator\fP< \fBUDSEntry\fP > \fBUDSEntryListIterator\fP"
.br
.ti -1c
.RI "typedef \fBQValueListConstIterator\fP< \fBUDSEntry\fP > \fBUDSEntryListConstIterator\fP"
.br
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBCommand\fP { \fBCMD_HOST\fP =  '0', \fBCMD_CONNECT\fP =  '1', \fBCMD_DISCONNECT\fP =  '2', \fBCMD_SLAVE_STATUS\fP =  '3', \fBCMD_SLAVE_CONNECT\fP =  '4', \fBCMD_SLAVE_HOLD\fP =  '5', \fBCMD_NONE\fP =  'A', \fBCMD_TESTDIR\fP =  'B', \fBCMD_GET\fP =  'C', \fBCMD_PUT\fP =  'D', \fBCMD_STAT\fP =  'E', \fBCMD_MIMETYPE\fP =  'F', \fBCMD_LISTDIR\fP =  'G', \fBCMD_MKDIR\fP =  'H', \fBCMD_RENAME\fP =  'I', \fBCMD_COPY\fP =  'J', \fBCMD_DEL\fP =  'K', \fBCMD_CHMOD\fP =  'L', \fBCMD_SPECIAL\fP =  'M', \fBCMD_USERPASS\fP =  'N', \fBCMD_REPARSECONFIGURATION\fP =  'O', \fBCMD_META_DATA\fP =  'P', \fBCMD_SYMLINK\fP =  'Q', \fBCMD_SUBURL\fP =  'R', \fBCMD_MESSAGEBOXANSWER\fP =  'S', \fBCMD_RESUMEANSWER\fP =  'T', \fBCMD_CONFIG\fP =  'U', \fBCMD_MULTI_GET\fP =  'V' }"
.br
.ti -1c
.RI "enum \fBError\fP { \fBERR_CANNOT_OPEN_FOR_READING\fP =  1, \fBERR_CANNOT_OPEN_FOR_WRITING\fP =  2, \fBERR_CANNOT_LAUNCH_PROCESS\fP =  3, \fBERR_INTERNAL\fP =  4, \fBERR_MALFORMED_URL\fP =  5, \fBERR_UNSUPPORTED_PROTOCOL\fP =  6, \fBERR_NO_SOURCE_PROTOCOL\fP =  7, \fBERR_UNSUPPORTED_ACTION\fP =  8, \fBERR_IS_DIRECTORY\fP =  9, \fBERR_IS_FILE\fP =  10, \fBERR_DOES_NOT_EXIST\fP =  11, \fBERR_FILE_ALREADY_EXIST\fP =  12, \fBERR_DIR_ALREADY_EXIST\fP =  13, \fBERR_UNKNOWN_HOST\fP =  14, \fBERR_ACCESS_DENIED\fP =  15, \fBERR_WRITE_ACCESS_DENIED\fP =  16, \fBERR_CANNOT_ENTER_DIRECTORY\fP =  17, \fBERR_PROTOCOL_IS_NOT_A_FILESYSTEM\fP =  18, \fBERR_CYCLIC_LINK\fP =  19, \fBERR_USER_CANCELED\fP =  20, \fBERR_CYCLIC_COPY\fP =  21, \fBERR_COULD_NOT_CREATE_SOCKET\fP =  22, \fBERR_COULD_NOT_CONNECT\fP =  23, \fBERR_CONNECTION_BROKEN\fP =  24, \fBERR_NOT_FILTER_PROTOCOL\fP =  25, \fBERR_COULD_NOT_MOUNT\fP =  26, \fBERR_COULD_NOT_UNMOUNT\fP =  27, \fBERR_COULD_NOT_READ\fP =  28, \fBERR_COULD_NOT_WRITE\fP =  29, \fBERR_COULD_NOT_BIND\fP =  30, \fBERR_COULD_NOT_LISTEN\fP =  31, \fBERR_COULD_NOT_ACCEPT\fP =  32, \fBERR_COULD_NOT_LOGIN\fP =  33, \fBERR_COULD_NOT_STAT\fP =  34, \fBERR_COULD_NOT_CLOSEDIR\fP =  35, \fBERR_COULD_NOT_MKDIR\fP =  37, \fBERR_COULD_NOT_RMDIR\fP =  38, \fBERR_CANNOT_RESUME\fP =  39, \fBERR_CANNOT_RENAME\fP =  40, \fBERR_CANNOT_CHMOD\fP =  41, \fBERR_CANNOT_DELETE\fP =  42, \fBERR_SLAVE_DIED\fP =  43, \fBERR_OUT_OF_MEMORY\fP =  44, \fBERR_UNKNOWN_PROXY_HOST\fP =  45, \fBERR_COULD_NOT_AUTHENTICATE\fP =  46, \fBERR_ABORTED\fP =  47, \fBERR_INTERNAL_SERVER\fP =  48, \fBERR_SERVER_TIMEOUT\fP =  49, \fBERR_SERVICE_NOT_AVAILABLE\fP =  50, \fBERR_UNKNOWN\fP =  51, \fBERR_UNKNOWN_INTERRUPT\fP =  53, \fBERR_CANNOT_DELETE_ORIGINAL\fP =  54, \fBERR_CANNOT_DELETE_PARTIAL\fP =  55, \fBERR_CANNOT_RENAME_ORIGINAL\fP =  56, \fBERR_CANNOT_RENAME_PARTIAL\fP =  57, \fBERR_NEED_PASSWD\fP =  58, \fBERR_CANNOT_SYMLINK\fP =  59, \fBERR_NO_CONTENT\fP =  60, \fBERR_DISK_FULL\fP =  61, \fBERR_IDENTICAL_FILES\fP =  62, \fBERR_SLAVE_DEFINED\fP =  63, \fBERR_UPGRADE_REQUIRED\fP =  64, \fBERR_POST_DENIED\fP =  65 }"
.br
.ti -1c
.RI "enum \fBUDSAtomTypes\fP { \fBUDS_STRING\fP =  1, \fBUDS_LONG\fP =  2, \fBUDS_TIME\fP =  4 | UDS_LONG, \fBUDS_SIZE\fP =  8 | UDS_LONG, \fBUDS_SIZE_LARGE\fP =  32768 | UDS_LONG, \fBUDS_USER\fP =  16 | UDS_STRING, \fBUDS_ICON_NAME\fP =  24 | UDS_STRING, \fBUDS_GROUP\fP =  32 | UDS_STRING, \fBUDS_EXTRA\fP =  48 | UDS_STRING, \fBUDS_NAME\fP =  64 | UDS_STRING, \fBUDS_LOCAL_PATH\fP =  72 | UDS_STRING, \fBUDS_ACCESS\fP =  128 | UDS_LONG, \fBUDS_MODIFICATION_TIME\fP =  256 | UDS_TIME, \fBUDS_ACCESS_TIME\fP =  512 | UDS_TIME, \fBUDS_CREATION_TIME\fP =  1024 | UDS_TIME, \fBUDS_FILE_TYPE\fP =  2048 | UDS_LONG, \fBUDS_LINK_DEST\fP =  4096 | UDS_STRING, \fBUDS_URL\fP =  8192 | UDS_STRING, \fBUDS_MIME_TYPE\fP =  16384 | UDS_STRING, \fBUDS_GUESSED_MIME_TYPE\fP =  16392 | UDS_STRING, \fBUDS_XML_PROPERTIES\fP =  32768 | UDS_STRING }"
.br
.ti -1c
.RI "enum \fBCacheControl\fP { \fBCC_CacheOnly\fP, \fBCC_Cache\fP, \fBCC_Verify\fP, \fBCC_Refresh\fP, \fBCC_Reload\fP }"
.br
.ti -1c
.RI "enum \fBFileSystemFlag\fP { \fBSupportsChmod\fP, \fBSupportsChown\fP, \fBSupportsUTime\fP, \fBSupportsSymlinks\fP, \fBCaseInsensitive\fP }"
.br
.ti -1c
.RI "enum \fBProgress\fP { \fBDEFAULT\fP =  1, \fBSTATUSBAR\fP =  2, \fBLIST\fP =  3 }"
.br
.ti -1c
.RI "enum \fBRenameDlg_Mode\fP { \fBM_OVERWRITE\fP =  1, \fBM_OVERWRITE_ITSELF\fP =  2, \fBM_SKIP\fP =  4, \fBM_SINGLE\fP =  8, \fBM_MULTI\fP =  16, \fBM_RESUME\fP =  32, \fBM_NORENAME\fP =  64 }"
.br
.ti -1c
.RI "enum \fBRenameDlg_Result\fP { \fBR_RESUME\fP =  6, \fBR_RESUME_ALL\fP =  7, \fBR_OVERWRITE\fP =  4, \fBR_OVERWRITE_ALL\fP =  5, \fBR_SKIP\fP =  2, \fBR_AUTO_SKIP\fP =  3, \fBR_RENAME\fP =  1, \fBR_CANCEL\fP =  0 }"
.br
.ti -1c
.RI "enum \fBSkipDlg_Result\fP { \fBS_SKIP\fP =  1, \fBS_AUTO_SKIP\fP =  2, \fBS_CANCEL\fP =  0 }"
.br
.ti -1c
.RI "enum \fBInfo\fP { \fBINF_TOTAL_SIZE\fP =  10, \fBINF_PROCESSED_SIZE\fP =  11, \fBINF_SPEED\fP, \fBINF_REDIRECTION\fP =  20, \fBINF_MIME_TYPE\fP =  21, \fBINF_ERROR_PAGE\fP =  22, \fBINF_WARNING\fP =  23, \fBINF_GETTING_FILE\fP, \fBINF_NEED_PASSWD\fP =  25, \fBINF_INFOMESSAGE\fP, \fBINF_META_DATA\fP, \fBINF_NETWORK_STATUS\fP, \fBINF_MESSAGEBOX\fP }"
.br
.ti -1c
.RI "enum \fBMessage\fP { \fBMSG_DATA\fP =  100, \fBMSG_DATA_REQ\fP, \fBMSG_ERROR\fP, \fBMSG_CONNECTED\fP, \fBMSG_FINISHED\fP, \fBMSG_STAT_ENTRY\fP, \fBMSG_LIST_ENTRIES\fP, \fBMSG_RENAMED\fP, \fBMSG_RESUME\fP, \fBMSG_SLAVE_STATUS\fP, \fBMSG_SLAVE_ACK\fP, \fBMSG_NET_REQUEST\fP, \fBMSG_NET_DROP\fP, \fBMSG_NEED_SUBURL_DATA\fP, \fBMSG_CANRESUME\fP, \fBMSG_AUTH_KEY\fP, \fBMSG_DEL_AUTH_KEY\fP }"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "KIO_EXPORT \fBQDataStream\fP & \fBoperator<<\fP (\fBQDataStream\fP &s, const \fBAuthInfo\fP &a)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQDataStream\fP & \fBoperator>>\fP (\fBQDataStream\fP &s, \fBAuthInfo\fP &a)"
.br
.ti -1c
.RI "KIO_EXPORT \fBChmodJob\fP * \fBchmod\fP (const \fBKFileItemList\fP &lstItems, int permissions, int mask, \fBQString\fP newOwner, \fBQString\fP newGroup, bool recursive, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBDavJob\fP * \fBdavPropFind\fP (const \fBKURL\fP &url, const \fBQDomDocument\fP &properties, \fBQString\fP depth, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBDavJob\fP * \fBdavPropPatch\fP (const \fBKURL\fP &url, const \fBQDomDocument\fP &properties, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBDavJob\fP * \fBdavSearch\fP (const \fBKURL\fP &url, const \fBQString\fP &nsURI, const \fBQString\fP &qName, const \fBQString\fP &query, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBconvertSize\fP (\fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBnumber\fP (\fBKIO::filesize_t\fP size)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBconvertSizeFromKB\fP (\fBKIO::filesize_t\fP kbSize)"
.br
.ti -1c
.RI "KIO_EXPORT unsigned int \fBcalculateRemainingSeconds\fP (\fBKIO::filesize_t\fP totalSize, \fBKIO::filesize_t\fP processedSize, \fBKIO::filesize_t\fP speed)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBconvertSeconds\fP (unsigned int seconds)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQTime\fP \fBcalculateRemaining\fP (\fBKIO::filesize_t\fP totalSize, \fBKIO::filesize_t\fP processedSize, \fBKIO::filesize_t\fP speed) KDE_DEPRECATED"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBitemsSummaryString\fP (uint items, uint files, uint dirs, \fBKIO::filesize_t\fP size, bool showSize)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBencodeFileName\fP (const \fBQString\fP &str)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBdecodeFileName\fP (const \fBQString\fP &str)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBbuildErrorString\fP (int errorCode, const \fBQString\fP &errorText)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBbuildHTMLErrorString\fP (int errorCode, const \fBQString\fP &errorText, const \fBKURL\fP *reqUrl=0L, int method=-1)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQByteArray\fP \fBrawErrorDetail\fP (int errorCode, const \fBQString\fP &errorText, const \fBKURL\fP *reqUrl=0L, int method=-1)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBunsupportedActionErrorString\fP (const \fBQString\fP &protocol, int cmd)"
.br
.ti -1c
.RI "KIO_EXPORT \fBKIO::CacheControl\fP \fBparseCacheControl\fP (const \fBQString\fP &cacheControl)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBgetCacheControlString\fP (\fBKIO::CacheControl\fP cacheControl)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBfindDeviceMountPoint\fP (const \fBQString\fP &device)"
.br
.ti -1c
.RI "KIO_EXPORT \fBQString\fP \fBfindPathMountPoint\fP (const \fBQString\fP &filename)"
.br
.ti -1c
.RI "KIO_EXPORT bool \fBprobably_slow_mounted\fP (const \fBQString\fP &filename)"
.br
.ti -1c
.RI "KIO_EXPORT bool \fBmanually_mounted\fP (const \fBQString\fP &filename)"
.br
.ti -1c
.RI "KIO_EXPORT bool \fBtestFileSystemFlag\fP (const \fBQString\fP &filename, FileSystemFlag flag)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBmkdir\fP (const \fBKURL\fP &url, int permissions=-1)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBrmdir\fP (const \fBKURL\fP &url)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBchmod\fP (const \fBKURL\fP &url, int permissions)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBrename\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, bool overwrite)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBsymlink\fP (const \fBQString\fP &target, const \fBKURL\fP &dest, bool overwrite, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBspecial\fP (const \fBKURL\fP &url, const \fBQByteArray\fP &data, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBmount\fP (bool ro, const char *fstype, const \fBQString\fP &dev, const \fBQString\fP &point, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBunmount\fP (const \fBQString\fP &point, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBhttp_update_cache\fP (const \fBKURL\fP &url, bool no_cache, time_t expireDate)"
.br
.ti -1c
.RI "KIO_EXPORT \fBStatJob\fP * \fBstat\fP (const \fBKURL\fP &url, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBStatJob\fP * \fBstat\fP (const \fBKURL\fP &url, bool sideIsSource, short int details, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBTransferJob\fP * \fBget\fP (const \fBKURL\fP &url, bool reload=false, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBTransferJob\fP * \fBput\fP (const \fBKURL\fP &url, int permissions, bool overwrite, bool resume, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBTransferJob\fP * \fBhttp_post\fP (const \fBKURL\fP &url, const \fBQByteArray\fP &postData, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBStoredTransferJob\fP * \fBstoredGet\fP (const \fBKURL\fP &url, bool reload=false, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBStoredTransferJob\fP * \fBstoredPut\fP (const \fBQByteArray\fP &arr, const \fBKURL\fP &url, int permissions, bool overwrite, bool resume, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBMultiGetJob\fP * \fBmulti_get\fP (long id, const \fBKURL\fP &url, const \fBMetaData\fP &metaData)"
.br
.ti -1c
.RI "KIO_EXPORT \fBMimetypeJob\fP * \fBmimetype\fP (const \fBKURL\fP &url, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBFileCopyJob\fP * \fBfile_copy\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, int permissions=-1, bool overwrite=false, bool resume=false, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBFileCopyJob\fP * \fBfile_move\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, int permissions=-1, bool overwrite=false, bool resume=false, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBSimpleJob\fP * \fBfile_delete\fP (const \fBKURL\fP &src, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBListJob\fP * \fBlistDir\fP (const \fBKURL\fP &url, bool showProgressInfo=true, bool includeHidden=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBListJob\fP * \fBlistRecursive\fP (const \fBKURL\fP &url, bool showProgressInfo=true, bool includeHidden=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBcopy\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBcopyAs\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBcopy\fP (const \fBKURL::List\fP &src, const \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBmove\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBmoveAs\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBmove\fP (const \fBKURL::List\fP &src, const \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBlink\fP (const \fBKURL\fP &src, const \fBKURL\fP &destDir, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBlink\fP (const \fBKURL::List\fP &src, const \fBKURL\fP &destDir, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBlinkAs\fP (const \fBKURL\fP &src, const \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBtrash\fP (const \fBKURL\fP &src, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBtrash\fP (const \fBKURL::List\fP &src, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBDeleteJob\fP * \fBdel\fP (const \fBKURL\fP &src, bool shred=false, bool showProgressInfo=true)"
.br
.ti -1c
.RI "KIO_EXPORT \fBDeleteJob\fP * \fBdel\fP (const \fBKURL::List\fP &src, bool shred=false, bool showProgressInfo=true)"
.br
.ti -1c
.RI "int \fBmatchConstraint\fP (const ParseTreeBase *_tree, const \fBKService::Ptr\fP &_service, const \fBKServiceTypeProfile::OfferList\fP &_list)"
.br
.ti -1c
.RI "PreferencesReturn \fBmatchPreferences\fP (const ParseTreeBase *_tree, const \fBKService::Ptr\fP &_service, const \fBKServiceTypeProfile::OfferList\fP &_list)"
.br
.ti -1c
.RI "KIO_EXPORT \fBParseTreeBase::Ptr\fP \fBparseConstraints\fP (const \fBQString\fP &_constr)"
.br
.ti -1c
.RI "KIO_EXPORT \fBParseTreeBase::Ptr\fP \fBparsePreferences\fP (const \fBQString\fP &_prefs)"
.br
.ti -1c
.RI "KIO_EXPORT \fBMetaInfoJob\fP * \fBfileMetaInfo\fP (const \fBKFileItemList\fP &items)"
.br
.ti -1c
.RI "KIO_EXPORT \fBMetaInfoJob\fP * \fBfileMetaInfo\fP (const \fBKURL::List\fP &items)"
.br
.ti -1c
.RI "class KIO_EXPORT \fBJob\fP * \fBpasteClipboard\fP (const \fBKURL\fP &_dest_url, bool move=false)"
.br
.ti -1c
.RI "KIO_EXPORT void \fBpasteData\fP (const \fBKURL\fP &_dest_url, const \fBQByteArray\fP &_data)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBpasteDataAsync\fP (const \fBKURL\fP &_dest_url, const \fBQByteArray\fP &_data)"
.br
.ti -1c
.RI "KIO_EXPORT \fBCopyJob\fP * \fBpasteDataAsync\fP (const \fBKURL\fP &_dest_url, const \fBQByteArray\fP &_data, const \fBQString\fP &text)"
.br
.ti -1c
.RI "KIO_EXPORT bool \fBisClipboardEmpty\fP ()"
.br
.ti -1c
.RI "KIO_EXPORT \fBPreviewJob\fP * \fBfilePreview\fP (const \fBKFileItemList\fP &items, int width, int height=0, int iconSize=0, int iconAlpha=70, bool scale=true, bool save=true, const \fBQStringList\fP *enabledPlugins=0)"
.br
.ti -1c
.RI "KIO_EXPORT \fBPreviewJob\fP * \fBfilePreview\fP (const \fBKURL::List\fP &items, int width, int height=0, int iconSize=0, int iconAlpha=70, bool scale=true, bool save=true, const \fBQStringList\fP *enabledPlugins=0)"
.br
.ti -1c
.RI "KIO_EXPORT \fBRenameDlg_Result\fP \fBopen_RenameDlg\fP (const \fBQString\fP &caption, const \fBQString\fP &src, const \fBQString\fP &dest, RenameDlg_Mode mode, \fBQString\fP &newDestPath, \fBKIO::filesize_t\fP sizeSrc=(\fBKIO::filesize_t\fP)-1, \fBKIO::filesize_t\fP sizeDest=(\fBKIO::filesize_t\fP)-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)"
.br
.ti -1c
.RI "KIO_EXPORT SkipDlg_Result \fBopen_SkipDlg\fP (bool _multi, const \fBQString\fP &_error_text=QString::null)"
.br
.ti -1c
.RI "static void \fBreadConfig\fP (\fBKConfig\fP *config, const \fBQString\fP &group, \fBMetaData\fP *metaData)"
.br
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "static \fBKStaticDeleter\fP< \fBSlaveConfig\fP > \fBslaveconfigsd\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A namespace for KIO globals. 
.SH "Typedef Documentation"
.PP 
.SS "typedef Q_LLONG \fBKIO::fileoffset_t\fP"
.PP
64-bit file offset 
.PP
Definition at line 37 of file global.h.
.SS "typedef Q_ULLONG \fBKIO::filesize_t\fP"
.PP
64-bit file size 
.PP
Definition at line 39 of file global.h.
.SS "typedef \fBQValueList\fP<UDSAtom> \fBKIO::UDSEntry\fP"
.PP
An entry is the list of atoms containing all the informations for a file or URL. 
.PP
Definition at line 483 of file global.h.
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBKIO::Command\fP"
.PP
Commands that can be invoked by a job. 
.PP
Definition at line 130 of file global.h.
.SS "enum \fBKIO::Error\fP"
.PP
Error codes that can be emitted by KIO. 
.PP
Definition at line 166 of file global.h.
.SS "enum \fBKIO::UDSAtomTypes\fP"
.PP
Constants used to specify the type of a KUDSAtom. 
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fIUDS_STRING \fP\fP
First let's define the item types. 
.TP
\fB\fIUDS_SIZE \fP\fP
Size of the file. 
.TP
\fB\fIUDS_USER \fP\fP
User ID of the file owner. 
.TP
\fB\fIUDS_ICON_NAME \fP\fP
Name of the icon, that should be used for displaying. 
.PP
It overrides all other detection mechanisms 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.TP
\fB\fIUDS_GROUP \fP\fP
Group ID of the file owner. 
.TP
\fB\fIUDS_EXTRA \fP\fP
Extra data (used only if you specified Columns/ColumnsTypes) This is the only UDS entry that can be repeated. 
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.TP
\fB\fIUDS_NAME \fP\fP
Filename - as displayed in directory listings etc. 
.PP
'.' has the usual special meaning of 'current directory' 
.TP
\fB\fIUDS_LOCAL_PATH \fP\fP
A local file path if the ioslave display files sitting on the local filesystem (but in another hierarchy, e.g. 
.PP
media:/) 
.TP
\fB\fIUDS_ACCESS \fP\fP
Access permissions (part of the mode returned by stat). 
.TP
\fB\fIUDS_MODIFICATION_TIME \fP\fP
The last time the file was modified. 
.TP
\fB\fIUDS_ACCESS_TIME \fP\fP
The last time the file was opened. 
.TP
\fB\fIUDS_CREATION_TIME \fP\fP
The time the file was created. 
.TP
\fB\fIUDS_FILE_TYPE \fP\fP
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. 
.TP
\fB\fIUDS_LINK_DEST \fP\fP
Name of the file where the link points to Allows to check for a symlink (don't use S_ISLNK !). 
.TP
\fB\fIUDS_URL \fP\fP
An alternative URL (If different from the caption). 
.TP
\fB\fIUDS_MIME_TYPE \fP\fP
A mime type; prevents guessing. 
.TP
\fB\fIUDS_GUESSED_MIME_TYPE \fP\fP
A mime type to be used for displaying only. 
.PP
But when 'running' the file, the mimetype is re-determined 
.TP
\fB\fIUDS_XML_PROPERTIES \fP\fP
XML properties, e.g. 
.PP
for WebDAV 
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Definition at line 297 of file global.h.
.SS "enum \fBKIO::CacheControl\fP"
.PP
Specifies how to use the cache. 
.PP
\fBSee also:\fP
.RS 4
\fBparseCacheControl()\fP 
.PP
\fBgetCacheControlString()\fP 
.RE
.PP

.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fICC_CacheOnly \fP\fP
Fail request if not in cache. 
.TP
\fB\fICC_Cache \fP\fP
Use cached entry if available. 
.TP
\fB\fICC_Verify \fP\fP
Validate cached entry with remote site if expired. 
.TP
\fB\fICC_Refresh \fP\fP
Always validate cached entry with remote site 
.PP
\fBSince:\fP
.RS 4
3.1. 
.RE
.PP

.TP
\fB\fICC_Reload \fP\fP
Always fetch from remote site. 
.PP
Definition at line 363 of file global.h.
.SS "enum \fBKIO::RenameDlg_Result\fP"
.PP
The result of open_RenameDlg(). 
.PP
Definition at line 40 of file renamedlg.h.
.SS "enum \fBKIO::Info\fP"
.PP
Identifiers for KIO informational messages. 
.PP
Definition at line 44 of file slaveinterface.h.
.SS "enum \fBKIO::Message\fP"
.PP
Identifiers for KIO data messages. 
.PP
Definition at line 64 of file slaveinterface.h.
.SH "Function Documentation"
.PP 
.SS "KIO_EXPORT \fBChmodJob\fP * KIO::chmod (const \fBKFileItemList\fP & lstItems, int permissions, int mask, \fBQString\fP newOwner, \fBQString\fP newGroup, bool recursive, bool showProgressInfo = \fCtrue\fP)"
.PP
Creates a job that changes permissions/ownership on several files or directories, optionally recursively. 
.PP
This version of chmod uses a KFileItemList so that it directly knows what to do with the items. TODO: a version that takes a \fBKURL::List\fP, and a general job that stats each url and returns a KFileItemList.
.PP
Note that change of ownership is only supported for local files.
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIlstItems\fP The file items representing several files or directories. 
.br
\fIpermissions\fP the permissions we want to set 
.br
\fImask\fP the bits we are allowed to change. For instance, if mask is 0077, we don't change the 'user' bits, only 'group' and 'others'. 
.br
\fInewOwner\fP If non-empty, the new owner for the files 
.br
\fInewGroup\fP If non-empty, the new group for the files 
.br
\fIrecursive\fP whether to open directories recursively 
.br
\fIshowProgressInfo\fP true to show progess information 
.RE
.PP
\fBReturns:\fP
.RS 4
The job handling the operation. 
.RE
.PP

.PP
Definition at line 223 of file chmodjob.cpp.
.PP
References endl(), QString::isEmpty(), and kdError().
.PP
Referenced by KFilePermissionsPropsPlugin::applyChanges(), and KIO::ForwardingSlaveBase::chmod().
.SS "\fBDavJob\fP * KIO::davPropFind (const \fBKURL\fP & url, const \fBQDomDocument\fP & properties, \fBQString\fP depth, bool showProgressInfo = \fCtrue\fP)"
.PP
Creates a new \fBDavJob\fP that issues a PROPFIND command. 
.PP
PROPFIND retrieves the properties of the resource identified by the given \fCurl\fP.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the URL of the resource 
.br
\fIproperties\fP a propfind document that describes the properties that should be retrieved 
.br
\fIdepth\fP the depth of the request. Can be '0', '1' or 'infinity' 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the new \fBDavJob\fP 
.RE
.PP

.PP
Definition at line 117 of file davjob.cpp.
.PP
References KIO::Job::addMetaData().
.SS "\fBDavJob\fP * KIO::davPropPatch (const \fBKURL\fP & url, const \fBQDomDocument\fP & properties, bool showProgressInfo = \fCtrue\fP)"
.PP
Creates a new \fBDavJob\fP that issues a PROPPATCH command. 
.PP
PROPPATCH sets the properties of the resource identified by the given \fCurl\fP.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the URL of the resource 
.br
\fIproperties\fP a PROPPACTCH document that describes the properties that should be modified and its new values 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the new \fBDavJob\fP 
.RE
.PP

.PP
Definition at line 125 of file davjob.cpp.
.SS "\fBDavJob\fP * KIO::davSearch (const \fBKURL\fP & url, const \fBQString\fP & nsURI, const \fBQString\fP & qName, const \fBQString\fP & query, bool showProgressInfo = \fCtrue\fP)"
.PP
Creates a new \fBDavJob\fP that issues a SEARCH command. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the URL of the resource 
.br
\fInsURI\fP the URI of the search method's qualified name 
.br
\fIqName\fP the local part of the search method's qualified name 
.br
\fIquery\fP the search string 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the new \fBDavJob\fP 
.RE
.PP

.PP
Definition at line 130 of file davjob.cpp.
.PP
References QDomDocument::createElementNS(), QDomDocument::createTextNode(), and QDomDocument::toString().
.SS "KIO_EXPORT \fBQString\fP KIO::convertSize (\fBKIO::filesize_t\fP size)"
.PP
Converts \fCsize\fP from bytes to the string representation. 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP size in bytes 
.RE
.PP
\fBReturns:\fP
.RS 4
converted size as a string - e.g. 123.4 kB , 12.0 MB 
.RE
.PP

.PP
Definition at line 45 of file global.cpp.
.PP
References QString::arg().
.PP
Referenced by convertSizeFromKB(), and KFileMimeTypeInfo::ItemInfo::string().
.SS "KIO_EXPORT \fBQString\fP KIO::number (\fBKIO::filesize_t\fP size)"
.PP
Converts a size to a string representation Not unlike \fBQString::number\fP(...). 
.PP
\fBParameters:\fP
.RS 4
\fIsize\fP size in bytes 
.RE
.PP
\fBReturns:\fP
.RS 4
converted size as a string - e.g. 123456789 
.RE
.PP

.PP
Definition at line 83 of file global.cpp.
.PP
References QString::fromLatin1().
.PP
Referenced by KIO::SlaveBase::canResume(), and KFileView::sortingKey().
.SS "KIO_EXPORT \fBQString\fP KIO::convertSizeFromKB (\fBKIO::filesize_t\fP kbSize)"
.PP
Converts size from kilo-bytes to the string representation. 
.PP
\fBParameters:\fP
.RS 4
\fIkbSize\fP size in kilo-bytes 
.RE
.PP
\fBReturns:\fP
.RS 4
converted size as a string - e.g. 123.4 kB , 12.0 MB 
.RE
.PP

.PP
Definition at line 78 of file global.cpp.
.PP
References convertSize().
.PP
Referenced by KFileMimeTypeInfo::ItemInfo::string().
.SS "KIO_EXPORT unsigned int KIO::calculateRemainingSeconds (\fBKIO::filesize_t\fP totalSize, \fBKIO::filesize_t\fP processedSize, \fBKIO::filesize_t\fP speed)"
.PP
Calculates remaining time in seconds from total size, processed size and speed. 
.PP
\fBParameters:\fP
.RS 4
\fItotalSize\fP total size in bytes 
.br
\fIprocessedSize\fP processed size in bytes 
.br
\fIspeed\fP speed in bytes per second 
.RE
.PP
\fBReturns:\fP
.RS 4
calculated remaining time in seconds
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 90 of file global.cpp.
.SS "KIO_EXPORT \fBQString\fP KIO::convertSeconds (unsigned int seconds)"
.PP
Convert \fCseconds\fP to a string representing number of days, hours, minutes and seconds. 
.PP
\fBParameters:\fP
.RS 4
\fIseconds\fP number of seconds to convert 
.RE
.PP
\fBReturns:\fP
.RS 4
string representation in a locale depending format
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 99 of file global.cpp.
.PP
References QString::arg().
.SS "KIO_EXPORT \fBQTime\fP KIO::calculateRemaining (\fBKIO::filesize_t\fP totalSize, \fBKIO::filesize_t\fP processedSize, \fBKIO::filesize_t\fP speed)"
.PP
Calculates remaining time from total size, processed size and speed. 
.PP
Warning: As \fBQTime\fP is limited to 23:59:59, use \fBcalculateRemainingSeconds()\fP instead
.PP
\fBParameters:\fP
.RS 4
\fItotalSize\fP total size in bytes 
.br
\fIprocessedSize\fP processed size in bytes 
.br
\fIspeed\fP speed in bytes per second 
.RE
.PP
\fBReturns:\fP
.RS 4
calculated remaining time 
.RE
.PP

.PP
Definition at line 114 of file global.cpp.
.PP
References QTime::setHMS().
.SS "KIO_EXPORT \fBQString\fP KIO::itemsSummaryString (uint items, uint files, uint dirs, \fBKIO::filesize_t\fP size, bool showSize)"
.PP
Helper for showing information about a set of files and directories. 
.PP
\fBParameters:\fP
.RS 4
\fIitems\fP the number of items (= \fCfiles\fP + \fCdirs\fP + number of symlinks :) 
.br
\fIfiles\fP the number of files 
.br
\fIdirs\fP the number of dirs 
.br
\fIsize\fP the sum of the size of the \fCfiles\fP 
.br
\fIshowSize\fP whether to show the size in the result 
.RE
.PP
\fBReturns:\fP
.RS 4
the summary string 
.RE
.PP

.PP
Definition at line 137 of file global.cpp.
.PP
References QString::arg().
.SS "KIO_EXPORT \fBQString\fP KIO::encodeFileName (const \fBQString\fP & str)"
.PP
Encodes (from the text displayed to the real filename) This translates  into % and / into 2f Used by \fBKIO::link\fP, for instance. 
.PP
\fBParameters:\fP
.RS 4
\fIstr\fP the file name to encode 
.RE
.PP
\fBReturns:\fP
.RS 4
the encoded file name 
.RE
.PP

.PP
Definition at line 152 of file global.cpp.
.PP
References QString::find(), and QString::replace().
.PP
Referenced by KFilePropsPlugin::applyChanges().
.SS "KIO_EXPORT \fBQString\fP KIO::decodeFileName (const \fBQString\fP & str)"
.PP
Decodes (from the filename to the text displayed) This translates 2[fF] into / and % into . 
.PP
\fBParameters:\fP
.RS 4
\fIstr\fP the file name to decode 
.RE
.PP
\fBReturns:\fP
.RS 4
the decoded file name 
.RE
.PP

.PP
Definition at line 167 of file global.cpp.
.PP
References QString::append().
.PP
Referenced by KFileItem::readUDSEntry(), and KFileItem::setName().
.SS "KIO_EXPORT \fBQString\fP KIO::buildErrorString (int errorCode, const \fBQString\fP & errorText)"
.PP
Returns a translated error message for \fCerrorCode\fP using the additional error information provided by \fCerrorText\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIerrorCode\fP the error code 
.br
\fIerrorText\fP the additional error text 
.RE
.PP
\fBReturns:\fP
.RS 4
the created error string 
.RE
.PP

.PP
Definition at line 200 of file global.cpp.
.PP
References QString::arg(), QString::fromLatin1(), and QString::isEmpty().
.PP
Referenced by KIO::Job::errorString(), and rawErrorDetail().
.SS "KIO_EXPORT \fBQString\fP buildHTMLErrorString (int errorCode, const \fBQString\fP & errorText, const \fBKURL\fP * reqUrl = \fC0L\fP, int method = \fC-1\fP)"
.PP
Returns a translated html error message for \fCerrorCode\fP using the additional error information provided by \fCerrorText\fP , \fCreqUrl\fP (the request URL), and the ioslave \fCmethod\fP . 
.PP
\fBParameters:\fP
.RS 4
\fIerrorCode\fP the error code 
.br
\fIerrorText\fP the additional error text 
.br
\fIreqUrl\fP the request URL 
.br
\fImethod\fP the ioslave method 
.RE
.PP
\fBReturns:\fP
.RS 4
the created error string 
.RE
.PP

.SS "KIO_EXPORT \fBQByteArray\fP KIO::rawErrorDetail (int errorCode, const \fBQString\fP & errorText, const \fBKURL\fP * reqUrl = \fC0L\fP, int method = \fC-1\fP)"
.PP
Returns translated error details for \fCerrorCode\fP using the additional error information provided by \fCerrorText\fP , \fCreqUrl\fP (the request URL), and the ioslave \fCmethod\fP . 
.PP
\fBParameters:\fP
.RS 4
\fIerrorCode\fP the error code 
.br
\fIerrorText\fP the additional error text 
.br
\fIreqUrl\fP the request URL 
.br
\fImethod\fP the ioslave method 
.RE
.PP
\fBReturns:\fP
.RS 4
the following data: 
.PD 0

.IP "\(bu" 2
\fBQString\fP errorName - the name of the error 
.IP "\(bu" 2
\fBQString\fP techName - if not null, the more technical name of the error 
.IP "\(bu" 2
\fBQString\fP description - a description of the error 
.IP "\(bu" 2
\fBQStringList\fP causes - a list of possible causes of the error 
.IP "\(bu" 2
\fBQStringList\fP solutions - a liso of solutions for the error 
.PP
.RE
.PP

.PP
Definition at line 495 of file global.cpp.
.PP
References QString::arg(), buildErrorString(), KLocale::formatDateTime(), QString::isNull(), QString::left(), KGlobal::locale(), and QString::mid().
.PP
Referenced by KIO::Job::detailedErrorStrings().
.SS "KIO_EXPORT \fBQString\fP KIO::unsupportedActionErrorString (const \fBQString\fP & protocol, int cmd)"
.PP
Returns an appropriate error message if the given command \fCcmd\fP is an unsupported action (ERR_UNSUPPORTED_ACTION). 
.PP
\fBParameters:\fP
.RS 4
\fIprotocol\fP name of the protocol 
.br
\fIcmd\fP given command 
.RE
.PP
\fBSee also:\fP
.RS 4
enum \fBCommand\fP 
.RE
.PP
\fBSince:\fP
.RS 4
3.2 
.RE
.PP

.PP
Definition at line 406 of file global.cpp.
.PP
References QString::arg().
.PP
Referenced by KIO::SlaveBase::chmod(), KIO::SlaveBase::copy(), KIO::SlaveBase::del(), KIO::SlaveBase::get(), KIO::SlaveBase::listDir(), KIO::SlaveBase::mkdir(), KIO::SlaveBase::multiGet(), KIO::SlaveBase::openConnection(), KIO::SlaveBase::put(), KIO::SlaveBase::rename(), KIO::SlaveBase::setSubURL(), KIO::SlaveBase::special(), KIO::SlaveBase::stat(), and KIO::SlaveBase::symlink().
.SS "\fBKIO::CacheControl\fP KIO::parseCacheControl (const \fBQString\fP & cacheControl)"
.PP
Parses the string representation of the cache control option. 
.PP
\fBParameters:\fP
.RS 4
\fIcacheControl\fP the string representation 
.RE
.PP
\fBReturns:\fP
.RS 4
the cache control value 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBgetCacheControlString()\fP 
.RE
.PP

.PP
Definition at line 1947 of file global.cpp.
.PP
References endl(), and kdDebug().
.PP
Referenced by KProtocolManager::cacheControl().
.SS "\fBQString\fP KIO::getCacheControlString (\fBKIO::CacheControl\fP cacheControl)"
.PP
Returns a string representation of the given cache control method. 
.PP
\fBParameters:\fP
.RS 4
\fIcacheControl\fP the cache control method 
.RE
.PP
\fBReturns:\fP
.RS 4
the string representation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBparseCacheControl()\fP 
.RE
.PP

.PP
Definition at line 1966 of file global.cpp.
.PP
References endl(), and kdDebug().
.SS "\fBQString\fP KIO::findDeviceMountPoint (const \fBQString\fP & device)"
.PP
Returns the mount point where \fCdevice\fP is mounted right now. 
.PP
This means, it has to be mounted, not just defined in fstab. 
.PP
Definition at line 1883 of file global.cpp.
.PP
Referenced by KDEDesktopMimeType::builtinServices(), KDEDesktopMimeType::executeService(), and KDEDesktopMimeType::icon().
.SS "\fBQString\fP KIO::findPathMountPoint (const \fBQString\fP & filename)"
.PP
Returns the mount point on which resides \fCfilename\fP. 
.PP
Q_OS_UNIX 
.PP
Definition at line 1889 of file global.cpp.
.PP
Referenced by KDiskFreeSp::findUsageInfo(), and KFilePropsPlugin::KFilePropsPlugin().
.SS "bool KIO::probably_slow_mounted (const \fBQString\fP & filename)"
.PP
Checks if the path belongs to a filesystem that is probably slow. 
.PP
Q_OS_UNIX 
.PP
Definition at line 1912 of file global.cpp.
.PP
References QString::isNull().
.SS "bool KIO::manually_mounted (const \fBQString\fP & filename)"
.PP
Checks if the path belongs to a filesystem that is manually mounted. 
.PP
Q_OS_UNIX 
.PP
Definition at line 1900 of file global.cpp.
.PP
References QString::isNull().
.SS "bool KIO::testFileSystemFlag (const \fBQString\fP & filename, FileSystemFlag flag)"
.PP
Checks the capabilities of the filesystem to which a given file belongs. 
.PP
given feature (e.g. chmod). 
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP the file name to check 
.br
\fIflag\fP the flag to check 
.RE
.PP
\fBReturns:\fP
.RS 4
true if the filesystem has that flag, false if not (or some error occurred)
.RE
.PP
The availables flags are: 
.PD 0

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

.PP
Definition at line 1924 of file global.cpp.
.PP
References endl(), QString::isNull(), and kdDebug().
.SS "\fBSimpleJob\fP * KIO::mkdir (const \fBKURL\fP & url, int permissions = \fC-1\fP)"
.PP
Creates a single directory. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP The URL of the directory to create. 
.br
\fIpermissions\fP The permissions to set after creating the directory (unix-style), -1 for default permissions. 
.RE
.PP
\fBReturns:\fP
.RS 4
A pointer to the job handling the operation. 
.RE
.PP

.PP
Definition at line 692 of file job.cpp.
.PP
Referenced by KIO::ForwardingSlaveBase::mkdir().
.SS "\fBSimpleJob\fP * KIO::rmdir (const \fBKURL\fP & url)"
.PP
Removes a single directory. 
.PP
The directory is assumed to be empty.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP The URL of the directory to remove. 
.RE
.PP
\fBReturns:\fP
.RS 4
A pointer to the job handling the operation. 
.RE
.PP

.PP
Definition at line 699 of file job.cpp.
.PP
Referenced by KIO::ForwardingSlaveBase::del().
.SS "\fBSimpleJob\fP * KIO::chmod (const \fBKURL\fP & url, int permissions)"
.PP
Changes permissions on a file or directory. 
.PP
See the other chmod below for changing many files or directories.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP The URL of file or directory. 
.br
\fIpermissions\fP The permissions to set. 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 706 of file job.cpp.
.SS "\fBSimpleJob\fP * KIO::rename (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool overwrite)"
.PP
Rename a file or directory. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP The original URL 
.br
\fIdest\fP The final URL 
.br
\fIoverwrite\fP whether to automatically overwrite if the dest exists 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 713 of file job.cpp.
.PP
Referenced by KIO::ForwardingSlaveBase::rename().
.SS "\fBSimpleJob\fP * KIO::symlink (const \fBQString\fP & target, const \fBKURL\fP & dest, bool overwrite, bool showProgressInfo = \fCtrue\fP)"
.PP
Create or move a symlink. 
.PP
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 \fBKIO::link\fP for that. 
.PP
\fBParameters:\fP
.RS 4
\fItarget\fP The string that will become the 'target' of the link (can be relative) 
.br
\fIdest\fP The symlink to create. 
.br
\fIoverwrite\fP whether to automatically overwrite if the dest exists 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 720 of file job.cpp.
.PP
Referenced by KIO::ForwardingSlaveBase::symlink().
.SS "\fBSimpleJob\fP * KIO::special (const \fBKURL\fP & url, const \fBQByteArray\fP & data, bool showProgressInfo = \fCtrue\fP)"
.PP
Execute any command that is specific to one slave (protocol). 
.PP
Examples are : HTTP POST, mount and unmount (kio_file)
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP The URL isn't passed to the slave, but is used to know which slave to send it to :-) 
.br
\fIdata\fP Packed data. The meaning is completely dependent on the slave, but usually starts with an int for the command number. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 727 of file job.cpp.
.PP
Referenced by mount(), and unmount().
.SS "\fBSimpleJob\fP * KIO::mount (bool ro, const char * fstype, const \fBQString\fP & dev, const \fBQString\fP & point, bool showProgressInfo = \fCtrue\fP)"
.PP
Mount filesystem. 
.PP
Special job for \fCkio_file\fP.
.PP
\fBParameters:\fP
.RS 4
\fIro\fP Mount read-only if \fCtrue\fP. 
.br
\fIfstype\fP File system type (e.g. 'ext2', can be 0L). 
.br
\fIdev\fP Device (e.g. /dev/sda0). 
.br
\fIpoint\fP Mount point, can be \fCnull\fP. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 733 of file job.cpp.
.PP
References QString::fromLatin1(), Observer::mounting(), Observer::self(), and special().
.SS "\fBSimpleJob\fP * KIO::unmount (const \fBQString\fP & point, bool showProgressInfo = \fCtrue\fP)"
.PP
Unmount filesystem. 
.PP
Special job for \fCkio_file\fP.
.PP
\fBParameters:\fP
.RS 4
\fIpoint\fP Point to unmount. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 743 of file job.cpp.
.PP
References Observer::self(), special(), and Observer::unmounting().
.SS "\fBSimpleJob\fP * KIO::http_update_cache (const \fBKURL\fP & url, bool no_cache, time_t expireDate)"
.PP
HTTP cache update. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Url to update, protocol must be 'http'. 
.br
\fIno_cache\fP If true, cache entry for \fCurl\fP is deleted. 
.br
\fIexpireDate\fP Local machine time indicating when the entry is supposed to expire. 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 845 of file job.cpp.
.PP
References KIO::Scheduler::scheduleJob().
.SS "\fBStatJob\fP * KIO::stat (const \fBKURL\fP & url, bool showProgressInfo = \fCtrue\fP)"
.PP
Find all details for one file or directory. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the URL of the file 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 827 of file job.cpp.
.PP
Referenced by KIO::ForwardingSlaveBase::stat().
.SS "\fBStatJob\fP * KIO::stat (const \fBKURL\fP & url, bool sideIsSource, short int details, bool showProgressInfo = \fCtrue\fP)"
.PP
Find all details for one file or directory. 
.PP
This version of the call includes two additional booleans, \fCsideIsSource\fP and \fCdetails\fP.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the URL of the file 
.br
\fIsideIsSource\fP 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: 
.PD 0

.IP "\(bu" 2
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 
.IP "\(bu" 2
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.
.PP
.br
\fIdetails\fP 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 \fBKRun\fP. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 833 of file job.cpp.
.PP
References endl(), kdDebug(), Observer::self(), KIO::StatJob::setDetails(), KIO::StatJob::setSide(), and Observer::stating().
.SS "\fBTransferJob\fP * KIO::get (const \fBKURL\fP & url, bool reload = \fCfalse\fP, bool showProgressInfo = \fCtrue\fP)"
.PP
Get (a.k.a. 
.PP
read).
.PP
The slave emits the data through data(). 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the URL of the file 
.br
\fIreload\fP true to reload the file, false if it can be taken from the cache 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 1161 of file job.cpp.
.PP
References KIO::Job::addMetaData().
.PP
Referenced by KIO::ForwardingSlaveBase::get().
.SS "\fBTransferJob\fP * KIO::put (const \fBKURL\fP & url, int permissions, bool overwrite, bool resume, bool showProgressInfo = \fCtrue\fP)"
.PP
Put (a.k.a. 
.PP
write)
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Where to write data. 
.br
\fIpermissions\fP May be -1. In this case no special permission mode is set. 
.br
\fIoverwrite\fP If true, any existing file will be overwritten. 
.br
\fIresume\fP true to resume an operation. Warning, setting this to true means that the data will be appended to \fCdest\fP if \fCdest\fP exists. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBmulti_get()\fP 
.RE
.PP

.PP
Definition at line 1321 of file job.cpp.
.PP
Referenced by KIO::ForwardingSlaveBase::put().
.SS "\fBTransferJob\fP * KIO::http_post (const \fBKURL\fP & url, const \fBQByteArray\fP & postData, bool showProgressInfo = \fCtrue\fP)"
.PP
HTTP POST (for form data). 
.PP
Example: 
.PP
.nf
    job = KIO::http_post( url, postData, false );
    job->addMetaData('content-type', contentType );
    job->addMetaData('referrer', referrerURL);

.fi
.PP
.PP
\fCpostData\fP is the data that you want to send and \fCcontentType\fP is the complete HTTP header line that specifies the content's MIME type, for example 'Content-Type: text/xml'.
.PP
You MUST specify content-type!
.PP
Often \fCcontentType\fP is 'Content-Type: application/x-www-form-urlencoded' and the \fCpostData\fP is then an ASCII string (without null-termination!) with characters like space, linefeed and percent escaped like 20, 0A and 25.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP Where to write the data. 
.br
\fIpostData\fP Encoded data to post. 
.br
\fIshowProgressInfo\fP true to display 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 1184 of file job.cpp.
.PP
References QValueList::begin(), QValueList::contains(), QValueList::end(), QString::isEmpty(), KURL::path(), KConfigBase::readIntListEntry(), KURL::setPath(), and QTimer::singleShot().
.SS "\fBStoredTransferJob\fP * KIO::storedGet (const \fBKURL\fP & url, bool reload = \fCfalse\fP, bool showProgressInfo = \fCtrue\fP)"
.PP
Get (a.k.a. 
.PP
read), into a single \fBQByteArray\fP. 
.PP
\fBSee also:\fP
.RS 4
\fBStoredTransferJob\fP
.RE
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the URL of the file 
.br
\fIreload\fP true to reload the file, false if it can be taken from the cache 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 1382 of file job.cpp.
.PP
References KIO::Job::addMetaData().
.SS "\fBStoredTransferJob\fP * KIO::storedPut (const \fBQByteArray\fP & arr, const \fBKURL\fP & url, int permissions, bool overwrite, bool resume, bool showProgressInfo = \fCtrue\fP)"
.PP
Put (a.k.a. 
.PP
write) data from a single \fBQByteArray\fP. 
.PP
\fBSee also:\fP
.RS 4
\fBStoredTransferJob\fP
.RE
.PP
\fBParameters:\fP
.RS 4
\fIarr\fP The data to write 
.br
\fIurl\fP Where to write data. 
.br
\fIpermissions\fP May be -1. In this case no special permission mode is set. 
.br
\fIoverwrite\fP If true, any existing file will be overwritten. 
.br
\fIresume\fP true to resume an operation. Warning, setting this to true means that the data will be appended to \fCdest\fP if \fCdest\fP exists. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP
\fBSince:\fP
.RS 4
3.3 
.RE
.PP

.PP
Definition at line 1392 of file job.cpp.
.PP
References KIO::StoredTransferJob::setData().
.SS "\fBMultiGetJob\fP * KIO::multi_get (long id, const \fBKURL\fP & url, const \fBMetaData\fP & metaData)"
.PP
Creates a new multiple get job. 
.PP
\fBParameters:\fP
.RS 4
\fIid\fP the id of the get operation 
.br
\fIurl\fP the URL of the file 
.br
\fImetaData\fP the \fBMetaData\fP associated with the file
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBget()\fP 
.RE
.PP

.PP
Definition at line 4387 of file job.cpp.
.PP
References KIO::MultiGetJob::get(), and KIO::MultiGetJob::MultiGetJob().
.SS "\fBMimetypeJob\fP * KIO::mimetype (const \fBKURL\fP & url, bool showProgressInfo = \fCtrue\fP)"
.PP
Find mimetype for one file or directory. 
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the URL of the file 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 1450 of file job.cpp.
.PP
References Observer::self(), and Observer::stating().
.PP
Referenced by KIO::ForwardingSlaveBase::mimetype(), and KIO::ForwardingSlaveBase::prepareUDSEntry().
.SS "\fBFileCopyJob\fP * KIO::file_copy (const \fBKURL\fP & src, const \fBKURL\fP & dest, int permissions = \fC-1\fP, bool overwrite = \fCfalse\fP, bool resume = \fCfalse\fP, bool showProgressInfo = \fCtrue\fP)"
.PP
Copy a single file. 
.PP
Uses either \fBSlaveBase::copy()\fP if the slave supports that or \fBget()\fP and \fBput()\fP otherwise. 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP Where to get the file. 
.br
\fIdest\fP Where to put the file. 
.br
\fIpermissions\fP May be -1. In this case no special permission mode is set. 
.br
\fIoverwrite\fP If true, any existing file will be overwritten. 
.br
\fIresume\fP true to resume an operation. Warning, setting this to true means that \fCsrc\fP will be appended to \fCdest\fP if \fCdest\fP exists. You probably don't want that, so leave it to false :)
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 1884 of file job.cpp.
.PP
Referenced by KIO::ForwardingSlaveBase::copy().
.SS "\fBFileCopyJob\fP * KIO::file_move (const \fBKURL\fP & src, const \fBKURL\fP & dest, int permissions = \fC-1\fP, bool overwrite = \fCfalse\fP, bool resume = \fCfalse\fP, bool showProgressInfo = \fCtrue\fP)"
.PP
Move a single file. 
.PP
Use either \fBSlaveBase::rename()\fP if the slave supports that, or \fBcopy()\fP and \fBdel()\fP otherwise, or eventually \fBget()\fP & \fBput()\fP & \fBdel()\fP 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP Where to get the file. 
.br
\fIdest\fP Where to put the file. 
.br
\fIpermissions\fP May be -1. In this case no special permission mode is set. 
.br
\fIoverwrite\fP If \fCtrue\fP, any existing file will be overwritten. 
.br
\fIresume\fP true to resume an operation. Warning, setting this to true means that \fCsrc\fP will be appended to \fCdest\fP if \fCdest\fP exists. You probably don't want that, so leave it to false :) 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 1890 of file job.cpp.
.SS "\fBSimpleJob\fP * KIO::file_delete (const \fBKURL\fP & src, bool showProgressInfo = \fCtrue\fP)"
.PP
Delete a single file. 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP File to delete. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 1896 of file job.cpp.
.SS "\fBListJob\fP * KIO::listDir (const \fBKURL\fP & url, bool showProgressInfo = \fCtrue\fP, bool includeHidden = \fCtrue\fP)"
.PP
List the contents of \fCurl\fP, which is assumed to be a directory. 
.PP
'.' and '..' are returned, filter them out if you don't want them.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the url of the directory 
.br
\fIshowProgressInfo\fP true to show progress information 
.br
\fIincludeHidden\fP true for all files, false to cull out UNIX hidden files/dirs (whose names start with dot) 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 2073 of file job.cpp.
.PP
Referenced by KIO::ForwardingSlaveBase::listDir().
.SS "\fBListJob\fP * KIO::listRecursive (const \fBKURL\fP & url, bool showProgressInfo = \fCtrue\fP, bool includeHidden = \fCtrue\fP)"
.PP
The same as the previous method, but recurses subdirectories. 
.PP
Directory links are not followed.
.PP
'.' and '..' are returned but only for the toplevel directory. Filter them out if you don't want them.
.PP
\fBParameters:\fP
.RS 4
\fIurl\fP the url of the directory 
.br
\fIshowProgressInfo\fP true to show progress information 
.br
\fIincludeHidden\fP true for all files, false to cull out UNIX hidden files/dirs (whose names start with dot) 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation. 
.RE
.PP

.PP
Definition at line 2079 of file job.cpp.
.PP
Referenced by KIO::DeleteJob::slotResult().
.SS "\fBCopyJob\fP * KIO::copy (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = \fCtrue\fP)"
.PP
Copy a file or directory \fCsrc\fP into the destination \fCdest\fP, which can be a file (including the final filename) or a directory (into which \fCsrc\fP will be copied). 
.PP
This emulates the cp command completely.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the file or directory to copy 
.br
\fIdest\fP the destination 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBcopyAs()\fP 
.RE
.PP

.PP
Definition at line 3710 of file job.cpp.
.PP
References QValueList::append().
.PP
Referenced by KFilePropsPlugin::applyChanges(), and pasteClipboard().
.SS "\fBCopyJob\fP * KIO::copyAs (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = \fCtrue\fP)"
.PP
Copy a file or directory \fCsrc\fP into the destination \fCdest\fP, which is the destination name in any case, even for a directory. 
.PP
As opposed to \fBcopy()\fP, 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.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the file or directory to copy 
.br
\fIdest\fP the destination 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP

.PP
Definition at line 3718 of file job.cpp.
.PP
References QValueList::append().
.SS "\fBCopyJob\fP * KIO::copy (const \fBKURL::List\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = \fCtrue\fP)"
.PP
Copy a list of file/dirs \fCsrc\fP into a destination directory \fCdest\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the list of files and/or directories 
.br
\fIdest\fP the destination 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP

.PP
Definition at line 3726 of file job.cpp.
.SS "\fBCopyJob\fP * KIO::move (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = \fCtrue\fP)"
.PP
Moves a file or directory \fCsrc\fP to the given destination \fCdest\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the file or directory to copy 
.br
\fIdest\fP the destination 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBcopy()\fP 
.PP
\fBmoveAs()\fP 
.RE
.PP

.PP
Definition at line 3731 of file job.cpp.
.PP
References QValueList::append().
.PP
Referenced by KFilePropsPlugin::applyChanges(), pasteClipboard(), and pasteDataAsync().
.SS "\fBCopyJob\fP * KIO::moveAs (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = \fCtrue\fP)"
.PP
Moves a file or directory \fCsrc\fP to the given destination \fCdest\fP. 
.PP
Unlike \fBmove()\fP this operation will fail when the directory already exists.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the file or directory to copy 
.br
\fIdest\fP the destination 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBcopyAs()\fP 
.RE
.PP

.PP
Definition at line 3738 of file job.cpp.
.PP
References QValueList::append().
.SS "\fBCopyJob\fP * KIO::move (const \fBKURL::List\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = \fCtrue\fP)"
.PP
Moves a list of files or directories \fCsrc\fP to the given destination \fCdest\fP. 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the list of files or directories to copy 
.br
\fIdest\fP the destination 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBcopy()\fP 
.RE
.PP

.PP
Definition at line 3745 of file job.cpp.
.SS "\fBCopyJob\fP * KIO::link (const \fBKURL\fP & src, const \fBKURL\fP & destDir, bool showProgressInfo = \fCtrue\fP)"
.PP
Create a link. 
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP The existing file or directory, 'target' of the link. 
.br
\fIdestDir\fP Destination directory where the link will be created. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP

.PP
Definition at line 3750 of file job.cpp.
.PP
References QValueList::append().
.SS "\fBCopyJob\fP * KIO::link (const \fBKURL::List\fP & src, const \fBKURL\fP & destDir, bool showProgressInfo = \fCtrue\fP)"
.PP
Create several links If the protocols and hosts are the same, a Unix symlink will be created. 
.PP
Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP The existing files or directories, 'targets' of the link. 
.br
\fIdestDir\fP Destination directory where the links will be created. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBlink()\fP 
.RE
.PP

.PP
Definition at line 3757 of file job.cpp.
.SS "\fBCopyJob\fP * KIO::linkAs (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = \fCtrue\fP)"
.PP
Create a link. 
.PP
Unlike \fBlink()\fP 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.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP The existing file or directory, 'target' of the link. 
.br
\fIdest\fP Destination directory where the link will be created. 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBlink\fP () 
.PP
\fBcopyAs()\fP 
.RE
.PP

.PP
Definition at line 3762 of file job.cpp.
.PP
References QValueList::append().
.SS "\fBCopyJob\fP * KIO::trash (const \fBKURL\fP & src, bool showProgressInfo = \fCtrue\fP)"
.PP
Trash a file or directory. 
.PP
This is currently only supported for local files and directories. Use 'KURL src; src.setPath( path );' to create a URL from a path.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP file to delete 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 3769 of file job.cpp.
.PP
References QValueList::append().
.PP
Referenced by KDirOperator::trash().
.SS "\fBCopyJob\fP * KIO::trash (const \fBKURL::List\fP & src, bool showProgressInfo = \fCtrue\fP)"
.PP
Trash a list of files or directories. 
.PP
This is currently only supported for local files and directories.
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the files to delete 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.PP
Definition at line 3776 of file job.cpp.
.SS "\fBDeleteJob\fP * KIO::del (const \fBKURL\fP & src, bool shred = \fCfalse\fP, bool showProgressInfo = \fCtrue\fP)"
.PP
Delete a file or directory. 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP file to delete 
.br
\fIshred\fP obsolete (TODO remove in KDE4) 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP

.PP
Definition at line 4205 of file job.cpp.
.PP
References QValueList::append().
.PP
Referenced by KDirOperator::del(), and KIO::ForwardingSlaveBase::del().
.SS "\fBDeleteJob\fP * KIO::del (const \fBKURL::List\fP & src, bool shred = \fCfalse\fP, bool showProgressInfo = \fCtrue\fP)"
.PP
Deletes a list of files or directories. 
.PP
\fBParameters:\fP
.RS 4
\fIsrc\fP the files to delete 
.br
\fIshred\fP obsolete (TODO remove in KDE4) 
.br
\fIshowProgressInfo\fP true to show progress information 
.RE
.PP
\fBReturns:\fP
.RS 4
the job handling the operation 
.RE
.PP

.PP
Definition at line 4213 of file job.cpp.
.SS "KIO_EXPORT \fBMetaInfoJob\fP * KIO::fileMetaInfo (const \fBKFileItemList\fP & items)"
.PP
Retrieves meta information for the given items. 
.PP
\fBParameters:\fP
.RS 4
\fIitems\fP files to get metainfo for 
.RE
.PP
\fBReturns:\fP
.RS 4
the \fBMetaInfoJob\fP to retrieve the items 
.RE
.PP

.PP
Definition at line 172 of file metainfojob.cpp.
.SS "KIO_EXPORT \fBMetaInfoJob\fP * KIO::fileMetaInfo (const \fBKURL::List\fP & items)"
.PP
Retrieves meta information for the given items. 
.PP
\fBParameters:\fP
.RS 4
\fIitems\fP files to get metainfo for 
.RE
.PP
\fBReturns:\fP
.RS 4
the \fBMetaInfoJob\fP to retrieve the items 
.RE
.PP

.PP
Definition at line 177 of file metainfojob.cpp.
.PP
References QPtrList::append().
.SS "KIO_EXPORT \fBKIO::Job\fP * KIO::pasteClipboard (const \fBKURL\fP & _dest_url, bool move = \fCfalse\fP)"
.PP
Pastes the content of the clipboard (e.g. 
.PP
URLs) to the given destination URL. 
.PP
\fBParameters:\fP
.RS 4
\fI_dest_url\fP the URL to receive the data 
.br
\fImove\fP true to move the data, false to copy 
.RE
.PP
\fBReturns:\fP
.RS 4
the job that handles the operation 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBpasteData()\fP 
.RE
.PP

.PP
Definition at line 94 of file paste.cpp.
.PP
References QApplication::clipboard(), copy(), QValueList::count(), KURLDrag::decode(), KMessageBox::error(), move(), pasteDataAsync(), KMessageBox::sorry(), and QStringList::split().
.SS "KIO_EXPORT void KIO::pasteData (const \fBKURL\fP & _dest_url, const \fBQByteArray\fP & _data)"
.PP
Pastes the given \fC_data\fP to the given destination URL. 
.PP
\fBParameters:\fP
.RS 4
\fI_dest_url\fP the URL to receive the data 
.br
\fI_data\fP the data to copy 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBpasteClipboard()\fP 
.RE
.PP

.PP
Definition at line 155 of file paste.cpp.
.PP
References KTempFile::close(), KTempFile::dataStream(), KURL::isEmpty(), KTempFile::name(), KTempFile::setAutoDelete(), KIO::NetAccess< T, K >::upload(), and QDataStream::writeRawBytes().
.SS "KIO_EXPORT \fBKIO::CopyJob\fP * KIO::pasteDataAsync (const \fBKURL\fP & _dest_url, const \fBQByteArray\fP & _data)"
.PP
Pastes the given \fC_data\fP to the given destination URL. 
.PP
\fBParameters:\fP
.RS 4
\fI_dest_url\fP the URL to receive the data 
.br
\fI_data\fP the data to copy 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBpasteClipboard()\fP 
.RE
.PP

.PP
Definition at line 172 of file paste.cpp.
.PP
Referenced by pasteClipboard().
.SS "KIO_EXPORT \fBKIO::CopyJob\fP * KIO::pasteDataAsync (const \fBKURL\fP & _dest_url, const \fBQByteArray\fP & _data, const \fBQString\fP & text)"
.PP
Pastes the given \fC_data\fP to the given destination URL. 
.PP
\fBParameters:\fP
.RS 4
\fI_dest_url\fP the URL to receive the data 
.br
\fI_data\fP the data to copy 
.br
\fItext\fP the text to show in the dialog 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBpasteClipboard()\fP 
.RE
.PP

.PP
Definition at line 177 of file paste.cpp.
.PP
References KTempFile::close(), KTempFile::dataStream(), KURL::isEmpty(), move(), KTempFile::name(), KURL::setPath(), and QDataStream::writeRawBytes().
.SS "KIO_EXPORT bool KIO::isClipboardEmpty ()"
.PP
Checks whether the clipboard is empty. 
.PP
\fBReturns:\fP
.RS 4
true if empty 
.RE
.PP

.PP
Definition at line 78 of file paste.cpp.
.PP
References QApplication::clipboard(), QString::contains(), QMimeSource::encodedData(), and QMimeSource::provides().
.SS "\fBPreviewJob\fP * KIO::filePreview (const \fBKFileItemList\fP & items, int width, int height = \fC0\fP, int iconSize = \fC0\fP, int iconAlpha = \fC70\fP, bool scale = \fCtrue\fP, bool save = \fCtrue\fP, const \fBQStringList\fP * enabledPlugins = \fC0\fP)"
.PP
Creates a \fBPreviewJob\fP to generate or retrieve a preview image for the given URL. 
.PP
\fBParameters:\fP
.RS 4
\fIitems\fP files to get previews for 
.br
\fIwidth\fP the maximum width to use 
.br
\fIheight\fP the maximum height to use, if this is 0, the same value as width is used. 
.br
\fIiconSize\fP 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. 
.br
\fIiconAlpha\fP transparency to use for the icon overlay 
.br
\fIscale\fP if the image is to be scaled to the requested size or returned in its original size 
.br
\fIsave\fP if the image should be cached for later use 
.br
\fIenabledPlugins\fP if non-zero, this points to a list containing the names of the plugins that may be used. 
.RE
.PP
\fBReturns:\fP
.RS 4
the new \fBPreviewJob\fP 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBPreviewJob::availablePlugins()\fP 
.RE
.PP

.PP
Definition at line 523 of file previewjob.cpp.
.PP
Referenced by KFileIconView::showPreviews().
.SS "\fBPreviewJob\fP * KIO::filePreview (const \fBKURL::List\fP & items, int width, int height = \fC0\fP, int iconSize = \fC0\fP, int iconAlpha = \fC70\fP, bool scale = \fCtrue\fP, bool save = \fCtrue\fP, const \fBQStringList\fP * enabledPlugins = \fC0\fP)"
.PP
Creates a \fBPreviewJob\fP to generate or retrieve a preview image for the given URL. 
.PP
\fBParameters:\fP
.RS 4
\fIitems\fP files to get previews for 
.br
\fIwidth\fP the maximum width to use 
.br
\fIheight\fP the maximum height to use, if this is 0, the same value as width is used. 
.br
\fIiconSize\fP 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. 
.br
\fIiconAlpha\fP transparency to use for the icon overlay 
.br
\fIscale\fP if the image is to be scaled to the requested size or returned in its original size 
.br
\fIsave\fP if the image should be cached for later use 
.br
\fIenabledPlugins\fP if non-zero, this points to a list containing the names of the plugins that may be used. 
.RE
.PP
\fBReturns:\fP
.RS 4
the new \fBPreviewJob\fP 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBPreviewJob::availablePlugins()\fP 
.RE
.PP

.PP
Definition at line 531 of file previewjob.cpp.
.PP
References QPtrList::append().
.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
