.TH "KIO" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO \- A namespace for KIO globals.  

.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 and kionetrc for automatic login purposes. An interface to kionetrc and 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 \fBDavJob\fP"
.br
.RI "\fIThe transfer job pumps data into and/or out of a Slave. \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 \fBTransferJob\fP"
.br
.RI "\fIThe transfer job pumps data into and/or out of a Slave. \fP"
.ti -1c
.RI "class \fBFileCopyJob\fP"
.br
.RI "\fIThe \fBFileCopyJob\fP copies data from one place to another. \fP"
.ti -1c
.RI "class \fBDeleteJob\fP"
.br
.ti -1c
.RI "class \fBMetaInfoJob\fP"
.br
.RI "\fI\fBSince:\fP
.RS 4
3.1 
.RE
.PP
\fP"
.ti -1c
.RI "class \fBNetAccess\fP"
.br
.RI "\fINet Transparency, formerly provided by kfmlib, but now done with \fBKIO::Job\fP. Provides a synchronous interface to io jobs. \fP"
.ti -1c
.RI "class \fBPasswordDialog\fP"
.br
.RI "\fIA dialog for requesting a login and a password from the end user. \fP"
.ti -1c
.RI "class \fBPreviewJob\fP"
.br
.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 
.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 (job) 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 signed long long int \fBfileoffset_t\fP"
.br
.ti -1c
.RI "typedef unsigned long long int \fBfilesize_t\fP"
.br
.ti -1c
.RI "typedef \fBQValueList\fP< UDSAtom > \fBUDSEntry\fP"
.br
.RI "\fIAn entry is the list of atoms containing all the informations for a file or URL. \fP"
.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 \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
.RI "\fIError codes that can be emitted by \fBKIO\fP. \fP"
.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_GROUP\fP =  32 | UDS_STRING, \fBUDS_NAME\fP =  64 | 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
.RI "\fIConstants used to specify the type of a KUDSAtom. \fP"
.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 \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 \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
.RI "\fICommands that can be invoked by a job. \fP"
.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
.RI "\fIIdentifiers for \fBKIO\fP informational messages. \fP"
.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
.RI "\fIIdentifiers for \fBKIO\fP data messages. \fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBQDataStream\fP & \fBoperator<<\fP (\fBQDataStream\fP &s, const  \fBAuthInfo\fP &a)"
.br
.ti -1c
.RI "\fBQDataStream\fP & \fBoperator>>\fP (\fBQDataStream\fP &s, \fBAuthInfo\fP &a)"
.br
.ti -1c
.RI "\fBChmodJob\fP * \fBchmod\fP (const  \fBKFileItemList\fP &lstItems, int permissions, int mask, \fBQString\fP newOwner, \fBQString\fP newGroup, bool recursive, bool showProgressInfo=true)"
.br
.RI "\fICreates a job that changes permissions/ownership on several files or directories, optionally recursively. \fP"
.ti -1c
.RI "\fBDavJob\fP * \fBdavPropFind\fP (const  \fBKURL\fP &url, const  \fBQDomDocument\fP &properties, \fBQString\fP depth, bool showProgressInfo=true)"
.br
.ti -1c
.RI "\fBDavJob\fP * \fBdavPropPatch\fP (const  \fBKURL\fP &url, const  \fBQDomDocument\fP &properties, bool showProgressInfo=true)"
.br
.ti -1c
.RI "\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 "\fBQString\fP \fBconvertSize\fP (KIO::filesize_t size)"
.br
.RI "\fIConverts \fCsize\fP from bytes to the string representation. \fP"
.ti -1c
.RI "\fBQString\fP \fBnumber\fP (KIO::filesize_t size)"
.br
.RI "\fIConverts a size to a string representation Not unlike \fBQString::number\fP(...). \fP"
.ti -1c
.RI "\fBQString\fP \fBconvertSizeFromKB\fP (KIO::filesize_t kbSize)"
.br
.RI "\fIConverts size from kilo-bytes to the string representation. \fP"
.ti -1c
.RI "\fBQTime\fP \fBcalculateRemaining\fP (KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed)"
.br
.RI "\fICalculates remaining time from total size, processed size and speed. \fP"
.ti -1c
.RI "\fBQString\fP \fBitemsSummaryString\fP (uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize)"
.br
.RI "\fIHelper for showing information about a set of files and directories \fCitems\fP = \fCfiles\fP + \fCdirs\fP + number of symlinks :). \fP"
.ti -1c
.RI "\fBQString\fP \fBencodeFileName\fP (const  \fBQString\fP &str)"
.br
.RI "\fIEncodes (from the text displayed to the real filename) This translates  into % and / into 2f Used by \fBKIO::link\fP, for instance. \fP"
.ti -1c
.RI "\fBQString\fP \fBdecodeFileName\fP (const  \fBQString\fP &str)"
.br
.RI "\fIDecodes (from the filename to the text displayed) This translates 2[fF] into / and % into . \fP"
.ti -1c
.RI "\fBQString\fP \fBbuildErrorString\fP (int errorCode, const  \fBQString\fP &errorText)"
.br
.ti -1c
.RI "\fBQString\fP \fBbuildHTMLErrorString\fP (int errorCode, const  \fBQString\fP &errorText, const  \fBKURL\fP *reqUrl=0L, int method=-1)"
.br
.ti -1c
.RI "\fBQByteArray\fP \fBrawErrorDetail\fP (int errorCode, const  \fBQString\fP &errorText, const  \fBKURL\fP *reqUrl=0L, int method=-1)"
.br
.ti -1c
.RI "\fBKIO::CacheControl\fP \fBparseCacheControl\fP (const  \fBQString\fP &cacheControl)"
.br
.ti -1c
.RI "\fBQString\fP \fBgetCacheControlString\fP (\fBKIO::CacheControl\fP cacheControl)"
.br
.ti -1c
.RI "\fBQString\fP \fBfindDeviceMountPoint\fP (const  \fBQString\fP &device)"
.br
.RI "\fIReturns the mount point where \fCdevice\fP is mounted right now. \fP"
.ti -1c
.RI "\fBQString\fP \fBfindPathMountPoint\fP (const  \fBQString\fP &filename)"
.br
.RI "\fIReturns the mount point on which resides \fCfilename\fP. \fP"
.ti -1c
.RI "bool \fBprobably_slow_mounted\fP (const  \fBQString\fP &filename)"
.br
.RI "\fIChecks if the path belongs to a filesystem that is probably slow. \fP"
.ti -1c
.RI "bool \fBmanually_mounted\fP (const  \fBQString\fP &filename)"
.br
.RI "\fIChecks if the path belongs to a filesystem that is manually mounted. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBmkdir\fP (const  \fBKURL\fP &url, int permissions=-1)"
.br
.RI "\fICreates a single directory. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBrmdir\fP (const  \fBKURL\fP &url)"
.br
.RI "\fIRemoves a single directory. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBchmod\fP (const  \fBKURL\fP &url, int permissions)"
.br
.RI "\fIChanges permissions on a file or directory. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBrename\fP (const  \fBKURL\fP &src, const  \fBKURL\fP &dest, bool overwrite)"
.br
.RI "\fIRename a file or directory. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBsymlink\fP (const  \fBQString\fP &target, const  \fBKURL\fP &dest, bool overwrite, bool showProgressInfo=true)"
.br
.RI "\fICreate or move a symlink. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBspecial\fP (const  \fBKURL\fP &url, const  \fBQByteArray\fP &data, bool showProgressInfo=true)"
.br
.RI "\fIExecute any command that is specific to one slave (protocol). \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBmount\fP (bool ro, const  char *fstype, const  \fBQString\fP &dev, const  \fBQString\fP &point, bool showProgressInfo=true)"
.br
.RI "\fIMount filesystem. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBunmount\fP (const  \fBQString\fP &point, bool showProgressInfo=true)"
.br
.RI "\fIUnmount filesystem. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBhttp_update_cache\fP (const  \fBKURL\fP &url, bool no_cache, time_t expireDate)"
.br
.RI "\fIHTTP cache update. \fP"
.ti -1c
.RI "StatJob * \fBstat\fP (const  \fBKURL\fP &url, bool showProgressInfo=true)"
.br
.RI "\fIFind all details for one file or directory. \fP"
.ti -1c
.RI "StatJob * \fBstat\fP (const  \fBKURL\fP &url, bool sideIsSource, short int details, bool showProgressInfo=true)"
.br
.RI "\fIFind all details for one file or directory. \fP"
.ti -1c
.RI "\fBTransferJob\fP * \fBget\fP (const  \fBKURL\fP &url, bool reload=false, bool showProgressInfo=true)"
.br
.RI "\fIGet (a.k.a. \fP"
.ti -1c
.RI "\fBTransferJob\fP * \fBput\fP (const  \fBKURL\fP &url, int permissions, bool overwrite, bool resume, bool showProgressInfo=true)"
.br
.RI "\fIPut (a.k.a. \fP"
.ti -1c
.RI "\fBTransferJob\fP * \fBhttp_post\fP (const  \fBKURL\fP &url, const  \fBQByteArray\fP &postData, bool showProgressInfo=true)"
.br
.RI "\fIHTTP POST (for form data). \fP"
.ti -1c
.RI "MultiGetJob * \fBmulti_get\fP (long id, const  \fBKURL\fP &url, const  MetaData &metaData)"
.br
.ti -1c
.RI "MimetypeJob * \fBmimetype\fP (const  \fBKURL\fP &url, bool showProgressInfo=true)"
.br
.RI "\fIFind mimetype for one file or directory. \fP"
.ti -1c
.RI "\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
.RI "\fICopy a single file. \fP"
.ti -1c
.RI "\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
.RI "\fIMove a single file. \fP"
.ti -1c
.RI "\fBSimpleJob\fP * \fBfile_delete\fP (const  \fBKURL\fP &src, bool showProgressInfo=true)"
.br
.RI "\fIDelete a single file. \fP"
.ti -1c
.RI "ListJob * \fBlistDir\fP (const  \fBKURL\fP &url, bool showProgressInfo=true, bool includeHidden=true)"
.br
.RI "\fIList the contents of \fCurl\fP, which is assumed to be a directory. \fP"
.ti -1c
.RI "ListJob * \fBlistRecursive\fP (const  \fBKURL\fP &url, bool showProgressInfo=true, bool includeHidden=true)"
.br
.RI "\fIThe same as the previous method, but recurses subdirectories. \fP"
.ti -1c
.RI "CopyJob * \fBcopy\fP (const  \fBKURL\fP &src, const  \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.RI "\fICopy a file or directory \fCsrc\fP into the destination , which can be a file (including the final filename) or a directory (into which \fCsrc\fP will be copied). \fP"
.ti -1c
.RI "CopyJob * \fBcopyAs\fP (const  \fBKURL\fP &src, const  \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.RI "\fICopy a file or directory \fCsrc\fP into the destination , which is the destination name in any case, even for a directory. \fP"
.ti -1c
.RI "CopyJob * \fBcopy\fP (const  \fBKURL::List\fP &src, const  \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.RI "\fICopy a list of file/dirs \fCsrc\fP into a destination directory \fCdest\fP. \fP"
.ti -1c
.RI "CopyJob * \fBmove\fP (const  \fBKURL\fP &src, const  \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "CopyJob * \fBmoveAs\fP (const  \fBKURL\fP &src, const  \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "CopyJob * \fBmove\fP (const  \fBKURL::List\fP &src, const  \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "CopyJob * \fBlink\fP (const  \fBKURL\fP &src, const  \fBKURL\fP &destDir, bool showProgressInfo=true)"
.br
.RI "\fICreate a link. \fP"
.ti -1c
.RI "CopyJob * \fBlink\fP (const  \fBKURL::List\fP &src, const  \fBKURL\fP &destDir, bool showProgressInfo=true)"
.br
.ti -1c
.RI "CopyJob * \fBlinkAs\fP (const  \fBKURL\fP &src, const  \fBKURL\fP &dest, bool showProgressInfo=true)"
.br
.ti -1c
.RI "\fBDeleteJob\fP * \fBdel\fP (const  \fBKURL\fP &src, bool shred=false, bool showProgressInfo=true)"
.br
.RI "\fIDelete a file or directory. \fP"
.ti -1c
.RI "\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 "\fBParseTreeBase::Ptr\fP \fBparseConstraints\fP (const  \fBQString\fP &_constr)"
.br
.ti -1c
.RI "\fBParseTreeBase::Ptr\fP \fBparsePreferences\fP (const  \fBQString\fP &_prefs)"
.br
.ti -1c
.RI "\fBMetaInfoJob\fP * \fBfileMetaInfo\fP (const  \fBKFileItemList\fP &items)"
.br
.RI "\fIRetrieves meta information for the given items. \fP"
.ti -1c
.RI "\fBMetaInfoJob\fP * \fBfileMetaInfo\fP (const  \fBKURL::List\fP &items)"
.br
.RI "\fISame as above, but takes a URL list instead of KFileItemList. \fP"
.ti -1c
.RI "\fBJob\fP * \fBpasteClipboard\fP (const  \fBKURL\fP &_dest_url, bool move=false)"
.br
.ti -1c
.RI "void \fBpasteData\fP (const  \fBKURL\fP &_dest_url, const  \fBQByteArray\fP &_data)"
.br
.ti -1c
.RI "bool \fBisClipboardEmpty\fP ()"
.br
.ti -1c
.RI "\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
.RI "\fIGenerates or retrieves a preview image for the given URL. \fP"
.ti -1c
.RI "\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
.RI "\fISame as above, but takes a URL list instead of KFileItemList. \fP"
.ti -1c
.RI "RenameDlg_Result \fBopen_RenameDlg\fP (const  \fBQString\fP &caption, const  \fBQString\fP &src, const  \fBQString\fP &dest, RenameDlg_Mode mode, \fBQString\fP &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)"
.br
.ti -1c
.RI "SkipDlg_Result \fBopen_SkipDlg\fP (bool _multi, const  \fBQString\fP &_error_text=QString::null)"
.br
.ti -1c
.RI "void \fBreadConfig\fP (\fBKConfig\fP *config, const  \fBQString\fP &group, MetaData *metaData)"
.br
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "\fBKStaticDeleter\fP< \fBSlaveConfig\fP > \fBslaveconfigsd\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A namespace for KIO globals. 
.SH "Typedef Documentation"
.PP 
.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. Definition at line 324 of file global.h.
.PP
Referenced by KFileItem::entry(), KFileItem::KFileItem(), KIO::SlaveBase::listEntry(), KFileItem::refresh(), KIO::PreviewJob::slotResult(), KIO::DeleteJob::slotResult(), KIO::NetAccess::stat(), and KIO::SlaveBase::statEntry().
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBKIO::Error\fP"
.PP
Error codes that can be emitted by KIO. Definition at line 97 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_GROUP \fP\fP
Group ID of the file owner. 
.TP
\fB\fIUDS_NAME \fP\fP
Filename. 
.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 207 of file global.h.
.SS "enum \fBKIO::CacheControl\fP"
.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 249 of file global.h.
.SS "enum \fBKIO::Command\fP"
.PP
Commands that can be invoked by a job. Definition at line 43 of file slaveinterface.h.
.SS "enum \fBKIO::Info\fP"
.PP
Identifiers for KIO informational messages. Definition at line 79 of file slaveinterface.h.
.SS "enum \fBKIO::Message\fP"
.PP
Identifiers for KIO data messages. Definition at line 99 of file slaveinterface.h.
.SH "Function Documentation"
.PP 
.SS "\fBChmodJob\fP * KIO::chmod (const \fBKFileItemList\fP & lstItems, int permissions, int mask, \fBQString\fP newOwner, \fBQString\fP newGroup, bool recursive, bool showProgressInfo = true)"
.PP
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 \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 behaviour 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
.RE
.PP
\fBReturns:\fP
.RS 4
The job handling the operation. 
.RE
.PP
Definition at line 236 of file chmodjob.cpp.
.PP
References QFile::encodeName(), and QString::isEmpty().
.PP
Referenced by KFilePermissionsPropsPlugin::applyChanges().
.SS "\fBQString\fP KIO::convertSize (KIO::filesize_t size)"
.PP
Converts \fCsize\fP from bytes to the string representation. \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
Definition at line 46 of file global.cpp.
.PP
References QString::arg(), and KGlobal::locale().
.PP
Referenced by convertSizeFromKB(), KFileItem::getToolTipText(), and KFileMimeTypeInfo::ItemInfo::string().
.SS "\fBQString\fP KIO::number (KIO::filesize_t size)"
.PP
Converts a size to a string representation Not unlike \fBQString::number\fP(...). \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
Definition at line 85 of file global.cpp.
.PP
References QString::fromLatin1().
.PP
Referenced by KIO::SlaveBase::canResume(), KBookmarkManager::findByAddress(), KURLBar::readItem(), KFileView::sortingKey(), and KURLBar::writeItem().
.SS "\fBQString\fP KIO::convertSizeFromKB (KIO::filesize_t kbSize)"
.PP
Converts size from kilo-bytes to the string representation. \fBParameters:\fP
.RS 4
\fIsize\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
Definition at line 80 of file global.cpp.
.PP
References convertSize().
.PP
Referenced by KFileMimeTypeInfo::ItemInfo::string().
.SS "\fBQTime\fP KIO::calculateRemaining (KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed)"
.PP
Calculates remaining time from total size, processed size and speed. \fBParameters:\fP
.RS 4
\fItotalSize\fP total size in bytes 
.br
\fIprocessedSize\fP processed size in bytes 
.br
\fIspeed\fP speed in bytes pre second 
.RE
.PP
\fBReturns:\fP
.RS 4
calculated remaining time 
.RE
.PP
Definition at line 92 of file global.cpp.
.PP
References QTime::setHMS().
.SS "\fBQString\fP KIO::itemsSummaryString (uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize)"
.PP
Helper for showing information about a set of files and directories \fCitems\fP = \fCfiles\fP + \fCdirs\fP + number of symlinks :). \fBParameters:\fP
.RS 4
\fIsize\fP the sum of the size of the _files_ 
.br
\fIshowSize\fP whether to show the size in the result 
.RE
.PP
Definition at line 115 of file global.cpp.
.PP
References QString::arg().
.SS "\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. Definition at line 130 of file global.cpp.
.PP
References QString::find(), and QString::replace().
.PP
Referenced by KFilePropsPlugin::applyChanges().
.SS "\fBQString\fP KIO::decodeFileName (const \fBQString\fP & str)"
.PP
Decodes (from the filename to the text displayed) This translates 2[fF] into / and % into . Definition at line 145 of file global.cpp.
.PP
References QString::append(), QString::length(), and QString::lower().
.PP
Referenced by KFileItem::KFileItem(), KFilePropsPlugin::KFilePropsPlugin(), KPropertiesDialog::KPropertiesDialog(), and KFileItem::setURL().
.SS "\fBQString\fP KIO::findDeviceMountPoint (const \fBQString\fP & device)"
.PP
Returns the mount point where \fCdevice\fP is mounted right now. This means, it has to be mounted, not just defined in fstab. Definition at line 1270 of file global.cpp.
.PP
References QFile::encodeName(), and QCString::length().
.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. For instance if /home is a separate partition, findPathMountPoint('/home/user/blah') will return /home Definition at line 1733 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. It checks for NFS or for paths belonging to automounted paths not yet mounted Definition at line 1746 of file global.cpp.
.SS "bool KIO::manually_mounted (const \fBQString\fP & filename)"
.PP
Checks if the path belongs to a filesystem that is manually mounted. \fBParameters:\fP
.RS 4
\fIfilename\fP the file name to check 
.RE
.PP
\fBReturns:\fP
.RS 4
true if the filesystem is manually mounted 
.RE
.PP
Definition at line 1739 of file global.cpp.
.SS "\fBSimpleJob\fP * KIO::mkdir (const \fBKURL\fP & url, int permissions = -1)"
.PP
Creates a single directory. \fBParameters:\fP
.RS 4
\fIurl\fP The URL of the directory to create. 
.br
\fIpermissions\fP The permissions to set after creating the directory. 
.RE
.PP
\fBReturns:\fP
.RS 4
A pointer to the job handling the operation. 
.RE
.PP
Definition at line 569 of file job.cpp.
.SS "\fBSimpleJob\fP * KIO::rmdir (const \fBKURL\fP & url)"
.PP
Removes a single directory. 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
Definition at line 576 of file job.cpp.
.SS "\fBSimpleJob\fP * KIO::chmod (const \fBKURL\fP & url, int permissions)"
.PP
Changes permissions on a file or directory. See the other \fBchmod\fP 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
Definition at line 583 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. 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
Definition at line 590 of file job.cpp.
.SS "\fBSimpleJob\fP * KIO::symlink (const \fBQString\fP & target, const \fBKURL\fP & dest, bool overwrite, bool showProgressInfo = true)"
.PP
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 \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 
.RE
.PP
\fBReturns:\fP
.RS 4
The job handling the operation. 
.RE
.PP
Definition at line 597 of file job.cpp.
.PP
Referenced by KTar::openArchive().
.SS "\fBSimpleJob\fP * KIO::special (const \fBKURL\fP & url, const \fBQByteArray\fP & data, bool showProgressInfo = true)"
.PP
Execute any command that is specific to one slave (protocol). 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. 
.RE
.PP
Definition at line 604 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 = true)"
.PP
Mount filesystem. 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. 
.RE
.PP
Definition at line 610 of file job.cpp.
.PP
References QString::fromLatin1(), Observer::mounting(), Observer::self(), and special().
.PP
Referenced by KDEDesktopMimeType::builtinServices(), and KAutoMount::KAutoMount().
.SS "\fBSimpleJob\fP * KIO::unmount (const \fBQString\fP & point, bool showProgressInfo = true)"
.PP
Unmount filesystem. Special job for \fCkio_file\fP.
.PP
\fBParameters:\fP
.RS 4
\fImount\fP Point to unmount. 
.RE
.PP
Definition at line 620 of file job.cpp.
.PP
References Observer::self(), special(), and Observer::unmounting().
.PP
Referenced by KDEDesktopMimeType::builtinServices(), and KAutoUnmount::KAutoUnmount().
.SS "\fBSimpleJob\fP * KIO::http_update_cache (const \fBKURL\fP & url, bool no_cache, time_t expireDate)"
.PP
HTTP cache update. \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
Definition at line 713 of file job.cpp.
.PP
References KURL::protocol().
.SS "StatJob * KIO::stat (const \fBKURL\fP & url, bool showProgressInfo = true)"
.PP
Find all details for one file or directory. Definition at line 695 of file job.cpp.
.PP
Referenced by KMimeType::findByURL(), and KPropertiesDialog::KPropertiesDialog().
.SS "StatJob * KIO::stat (const \fBKURL\fP & url, bool sideIsSource, short int details, bool showProgressInfo = true)"
.PP
Find all details for one file or directory. This version of the call includes two additional booleans, \fCsideIsSource\fP and \fCdetails\fP.
.PP
\fBParameters:\fP
.RS 4
\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).
.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. 
.RE
.PP
Definition at line 701 of file job.cpp.
.PP
References KURL::prettyURL(), Observer::self(), and Observer::stating().
.SS "\fBTransferJob\fP * KIO::get (const \fBKURL\fP & url, bool reload = false, bool showProgressInfo = true)"
.PP
Get (a.k.a. read).
.PP
The slave emits the data through \fBdata\fP(). Definition at line 972 of file job.cpp.
.PP
References KIO::Job::addMetaData(), and KStdAccel::reload().
.SS "\fBTransferJob\fP * KIO::put (const \fBKURL\fP & url, int permissions, bool overwrite, bool resume, bool showProgressInfo = true)"
.PP
Put (a.k.a. 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 \fCtrue\fP, any existing file will be overwritten. 
.br
\fIresume\fP 
.RE
.PP
Definition at line 1107 of file job.cpp.
.SS "\fBTransferJob\fP * KIO::http_post (const \fBKURL\fP & url, const \fBQByteArray\fP & postData, bool showProgressInfo = true)"
.PP
HTTP POST (for form data). Example: 
.PP
.nf

    job = KIO::http_post( url, postData, false );
    job->addMetaData('content-type', contentType );
    job->addMetaData('referrer', referrerURL);
 
.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 data. 
.br
\fIpostData\fP Encoded data to post. 
.br
\fIshowProgressInfo\fP true to display 
.RE
.PP
Definition at line 994 of file job.cpp.
.PP
References QValueList< int >::begin(), QValueList< int >::contains(), QValueList< int >::end(), KURL::port(), KURL::protocol(), KConfigBase::readIntListEntry(), and KURL::url().
.SS "MimetypeJob * KIO::mimetype (const \fBKURL\fP & url, bool showProgressInfo = true)"
.PP
Find mimetype for one file or directory. Definition at line 1164 of file job.cpp.
.PP
References Observer::self(), and Observer::stating().
.PP
Referenced by KFilterDev::device(), KFilterDev::deviceForFile(), KTar::KTar(), and KDataToolInfo::query().
.SS "\fBFileCopyJob\fP * KIO::file_copy (const \fBKURL\fP & src, const \fBKURL\fP & dest, int permissions = -1, bool overwrite = false, bool resume = false, bool showProgressInfo = true)"
.PP
Copy a single file. 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 \fCtrue\fP, any existing file will be overwritten. 
.br
\fIresume\fP 
.RE
.PP
Definition at line 1530 of file job.cpp.
.SS "\fBFileCopyJob\fP * KIO::file_move (const \fBKURL\fP & src, const \fBKURL\fP & dest, int permissions = -1, bool overwrite = false, bool resume = false, bool showProgressInfo = true)"
.PP
Move a single file. 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 
.RE
.PP
Definition at line 1536 of file job.cpp.
.SS "\fBSimpleJob\fP * KIO::file_delete (const \fBKURL\fP & src, bool showProgressInfo = true)"
.PP
Delete a single file. \fBParameters:\fP
.RS 4
\fIsrc\fP File to delete. 
.RE
.PP
Definition at line 1542 of file job.cpp.
.SS "ListJob * KIO::listDir (const \fBKURL\fP & url, bool showProgressInfo = true, bool includeHidden = true)"
.PP
List the contents of \fCurl\fP, which is assumed to be a directory. '.' and '..' are returned, filter them out if you don't want them.
.PP
pass includeHidden = false to cull out UNIX hidden files/dirs (whose names start with .) Definition at line 1691 of file job.cpp.
.SS "ListJob * KIO::listRecursive (const \fBKURL\fP & url, bool showProgressInfo = true, bool includeHidden = true)"
.PP
The same as the previous method, but recurses subdirectories. '.' and '..' are returned but only for the toplevel directory. Filter them out if you don't want them.
.PP
pass includeHidden = false to cull out UNIX hidden files/dirs (whose names start with .) Definition at line 1697 of file job.cpp.
.PP
Referenced by KIO::DeleteJob::slotResult().
.SS "CopyJob * KIO::copy (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = true)"
.PP
Copy a file or directory \fCsrc\fP into the destination , which can be a file (including the final filename) or a directory (into which \fCsrc\fP will be copied). This emulates the \fCcp\fP command completely. Definition at line 2917 of file job.cpp.
.PP
References QValueList< KURL >::append().
.PP
Referenced by KFilePropsPlugin::applyChanges().
.SS "CopyJob * KIO::copyAs (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = true)"
.PP
Copy a file or directory \fCsrc\fP into the destination , which is the destination name in any case, even for a directory. As opposed to \fBcopy\fP, this doesn't emulate \fCcp\fP, 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. Definition at line 2925 of file job.cpp.
.PP
References QValueList< KURL >::append().
.SS "CopyJob * KIO::copy (const \fBKURL::List\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = true)"
.PP
Copy a list of file/dirs \fCsrc\fP into a destination directory \fCdest\fP. Definition at line 2933 of file job.cpp.
.SS "CopyJob * KIO::move (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = true)"
.PP
\fBSee also:\fP
.RS 4
\fBcopy\fP 
.RE
.PP
Definition at line 2938 of file job.cpp.
.PP
References QValueList< KURL >::append().
.PP
Referenced by KFilePropsPlugin::applyChanges().
.SS "CopyJob * KIO::moveAs (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = true)"
.PP
\fBSee also:\fP
.RS 4
\fBcopyAs\fP 
.RE
.PP
Definition at line 2945 of file job.cpp.
.PP
References QValueList< KURL >::append().
.SS "CopyJob * KIO::move (const \fBKURL::List\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = true)"
.PP
\fBSee also:\fP
.RS 4
\fBcopy\fP 
.RE
.PP
Definition at line 2952 of file job.cpp.
.SS "CopyJob * KIO::link (const \fBKURL\fP & src, const \fBKURL\fP & destDir, bool showProgressInfo = true)"
.PP
Create a link. \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. 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. 
.RE
.PP
Definition at line 2957 of file job.cpp.
.PP
References QValueList< KURL >::append().
.SS "CopyJob * KIO::link (const \fBKURL::List\fP & src, const \fBKURL\fP & destDir, bool showProgressInfo = true)"
.PP
\fBSee also:\fP
.RS 4
\fBlink\fP 
.RE
.PP
Definition at line 2964 of file job.cpp.
.SS "CopyJob * KIO::linkAs (const \fBKURL\fP & src, const \fBKURL\fP & dest, bool showProgressInfo = true)"
.PP
\fBSee also:\fP
.RS 4
\fBlink\fP and \fBcopyAs\fP 
.RE
.PP
Definition at line 2969 of file job.cpp.
.PP
References QValueList< KURL >::append().
.SS "\fBDeleteJob\fP * KIO::del (const \fBKURL\fP & src, bool shred = false, bool showProgressInfo = true)"
.PP
Delete a file or directory. \fBParameters:\fP
.RS 4
\fIsrc\fP file to delete 
.br
\fIshred\fP If \fCtrue\fP, delete in a way that makes recovery impossible (only supported for local files currently) 
.RE
.PP
Definition at line 3390 of file job.cpp.
.PP
References QValueList< KURL >::append().
.PP
Referenced by KDirOperator::del().
.SS "int KIO::matchConstraint (const ParseTreeBase * _tree, const \fBKService::Ptr\fP &, const \fBKServiceTypeProfile::OfferList\fP &)"
.PP
\fBReturns:\fP
.RS 4
0 => Does not match 1 => Does match <0 => Error 
.RE
.PP
Definition at line 591 of file ktraderparsetree.cpp.
.PP
References matchConstraint().
.PP
Referenced by matchConstraint(), and KTrader::query().
.SS "PreferencesReturn KIO::matchPreferences (const ParseTreeBase * _tree, const \fBKService::Ptr\fP &, const \fBKServiceTypeProfile::OfferList\fP &)"
.PP
\fBReturns:\fP
.RS 4
1 on success or <0 on Error 
.RE
.PP
Definition at line 612 of file ktraderparsetree.cpp.
.PP
References matchPreferences().
.PP
Referenced by matchPreferences(), and KTrader::query().
.SS "\fBMetaInfoJob\fP * KIO::fileMetaInfo (const \fBKFileItemList\fP & items)"
.PP
Retrieves meta information for the given items. \fBParameters:\fP
.RS 4
\fIitems\fP files to get metainfo for 
.br
\fIsave\fP if the data 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. see \fBavailablePlugins\fP. 
.RE
.PP
Definition at line 175 of file metainfojob.cpp.
.SS "\fBMetaInfoJob\fP * KIO::fileMetaInfo (const \fBKURL::List\fP & items)"
.PP
Same as above, but takes a URL list instead of KFileItemList. Definition at line 180 of file metainfojob.cpp.
.PP
References QPtrList::append(), QValueList< KURL >::begin(), QValueList< KURL >::ConstIterator(), and QValueList< KURL >::end().
.SS "\fBPreviewJob\fP * KIO::filePreview (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)"
.PP
Generates or retrieves a preview image for the given URL. \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. see \fBavailablePlugins\fP. 
.RE
.PP
Definition at line 494 of file previewjob.cpp.
.PP
References KStdAccel::save().
.PP
Referenced by KFileIconView::showPreviews().
.SS "\fBPreviewJob\fP * KIO::filePreview (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)"
.PP
Same as above, but takes a URL list instead of KFileItemList. Definition at line 502 of file previewjob.cpp.
.PP
References QPtrList::append(), QValueList< KURL >::begin(), QValueList< KURL >::ConstIterator(), QValueList< KURL >::end(), and KStdAccel::save().
.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
