KIO Namespace Reference
A namespace for KIO globals. More...
Compounds | |
class | AuthInfo |
This class is intended to make it easier to prompt for, cache and retrieve authorization information. A two way messaging class for passing authentication information. More... | |
class | NetRC |
A Singleton class that provides access to passwords stored in .netrc files for automatic login purposes. An interface to the ftp .netrc files. More... | |
struct | AutoLogin |
Contains auto login information. More... | |
class | ChmodJob |
This job changes permissions on a list of files or directories, optionally in a recursive manner. More... | |
class | Connection |
This class provides a simple means for IPC between two applications via a pipe. More... | |
class | DataProtocol |
This kioslave provides support of data urls as specified by rfc 2397. More... | |
class | DataSlave |
This class provides a high performance implementation for the data url scheme (rfc2397). More... | |
struct | QueueStruct |
structure for queueing. More... | |
class | DavJob |
The transfer job pumps data into and/or out of a Slave. More... | |
class | MetaData |
MetaData is a simple map of key/value strings. More... | |
class | Job |
The base class for all jobs. More... | |
class | SimpleJob |
A simple job (one url and one command). More... | |
class | StatJob |
A KIO job that retrieves information about a file or directory. More... | |
class | TransferJob |
The transfer job pumps data into and/or out of a Slave. More... | |
class | MultiGetJob |
The MultiGetJob is a TransferJob that allows you to get several files from a single server. More... | |
class | MimetypeJob |
A MimetypeJob is a TransferJob that allows you to get the mime type of an URL. More... | |
class | FileCopyJob |
The FileCopyJob copies data from one place to another. More... | |
class | ListJob |
A ListJob is allows you to get the get the content of a directory. More... | |
class | CopyJob |
CopyJob is used to move, copy or symlink files and directories. More... | |
class | DeleteJob |
A more complex Job to delete files and directories. More... | |
class | MetaInfoJob |
MetaInfoJob is a KIO Job to retrieve meta information from files. KIO Job to retrieve meta information from files.
| |
class | NetAccess |
Net Transparency. Provides an easy, synchronous interface to KIO file operations. More... | |
class | PasswordDialog |
A dialog for requesting a login and a password from the end user. dialog for requesting login and password from the end user. More... | |
class | PreviewJob |
KIO Job to get a thumbnail picture. More... | |
class | ProgressBase |
This class does all initialization stuff for progress, like connecting signals to slots. Base class for IO progress dialogs. More... | |
class | RenameDlg |
A dialog for the options to rename two files. A dialog for renaming files.
| |
class | Scheduler |
The KIO::Scheduler manages io-slaves for the application. More... | |
class | SlaveBase |
There are two classes that specifies the protocol between application (job) and kioslave. More... | |
class | SlaveConfig |
SlaveConfig. More... | |
class | SlaveInterface |
There are two classes that specifies the protocol between application ( KIO::Job) and kioslave. More... | |
class | StatusbarProgress |
This is a special IO progress widget. IO progress widget for embedding in a statusbar. More... | |
class | TCPSlaveBase |
There are two classes that specifies the protocol between application (job) and kioslave. More... | |
Typedefs | |
typedef signed long long int | fileoffset_t |
typedef unsigned long long int | filesize_t |
typedef QValueList< UDSAtom > | UDSEntry |
Enumerations | |
enum | Command |
enum | Error |
enum | UDSAtomTypes { UDS_STRING = 1 , UDS_SIZE = 8 | UDS_LONG , UDS_USER = 16 | UDS_STRING, UDS_ICON_NAME = 24 | UDS_STRING, UDS_GROUP = 32 | UDS_STRING, UDS_EXTRA = 48 | UDS_STRING, UDS_NAME = 64 | UDS_STRING, UDS_ACCESS = 128 | UDS_LONG, UDS_MODIFICATION_TIME = 256 | UDS_TIME, UDS_ACCESS_TIME = 512 | UDS_TIME, UDS_CREATION_TIME = 1024 | UDS_TIME, UDS_FILE_TYPE = 2048 | UDS_LONG, UDS_LINK_DEST = 4096 | UDS_STRING, UDS_URL = 8192 | UDS_STRING, UDS_MIME_TYPE = 16384 | UDS_STRING, UDS_GUESSED_MIME_TYPE = 16392 | UDS_STRING, UDS_XML_PROPERTIES = 32768 | UDS_STRING } |
enum | CacheControl { CC_CacheOnly, CC_Cache, CC_Verify, CC_Refresh, CC_Reload } |
enum | RenameDlg_Result |
enum | Info |
enum | Message |
Functions | |
ChmodJob * | chmod (const KFileItemList &lstItems, int permissions, int mask, QString newOwner, QString newGroup, bool recursive, bool showProgressInfo=true) |
DavJob * | davPropFind (const KURL &url, const QDomDocument &properties, QString depth, bool showProgressInfo=true) |
DavJob * | davPropPatch (const KURL &url, const QDomDocument &properties, bool showProgressInfo=true) |
DavJob * | davSearch (const KURL &url, const QString &nsURI, const QString &qName, const QString &query, bool showProgressInfo=true) |
QString | convertSize (KIO::filesize_t size) |
QString | number (KIO::filesize_t size) |
QString | convertSizeFromKB (KIO::filesize_t kbSize) |
QTime | calculateRemaining (KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed) |
QString | itemsSummaryString (uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize) |
QString | encodeFileName (const QString &str) |
QString | decodeFileName (const QString &str) |
QString | buildErrorString (int errorCode, const QString &errorText) |
QString | buildHTMLErrorString (int errorCode, const QString &errorText, const KURL *reqUrl=0L, int method=-1) |
QByteArray | rawErrorDetail (int errorCode, const QString &errorText, const KURL *reqUrl=0L, int method=-1) |
QString | unsupportedActionErrorString (const QString &protocol, int cmd) |
KIO::CacheControl | parseCacheControl (const QString &cacheControl) |
QString | getCacheControlString (KIO::CacheControl cacheControl) |
QString | findDeviceMountPoint (const QString &device) |
QString | findPathMountPoint (const QString &filename) |
bool | probably_slow_mounted (const QString &filename) |
bool | manually_mounted (const QString &filename) |
bool | testFileSystemFlag (const QString &filename, FileSystemFlag flag) |
SimpleJob * | mkdir (const KURL &url, int permissions=-1) |
SimpleJob * | rmdir (const KURL &url) |
SimpleJob * | chmod (const KURL &url, int permissions) |
SimpleJob * | rename (const KURL &src, const KURL &dest, bool overwrite) |
SimpleJob * | symlink (const QString &target, const KURL &dest, bool overwrite, bool showProgressInfo=true) |
SimpleJob * | special (const KURL &url, const QByteArray &data, bool showProgressInfo=true) |
SimpleJob * | mount (bool ro, const char *fstype, const QString &dev, const QString &point, bool showProgressInfo=true) |
SimpleJob * | unmount (const QString &point, bool showProgressInfo=true) |
SimpleJob * | http_update_cache (const KURL &url, bool no_cache, time_t expireDate) |
StatJob * | stat (const KURL &url, bool showProgressInfo=true) |
StatJob * | stat (const KURL &url, bool sideIsSource, short int details, bool showProgressInfo=true) |
TransferJob * | get (const KURL &url, bool reload=false, bool showProgressInfo=true) |
TransferJob * | put (const KURL &url, int permissions, bool overwrite, bool resume, bool showProgressInfo=true) |
TransferJob * | http_post (const KURL &url, const QByteArray &postData, bool showProgressInfo=true) |
MultiGetJob * | multi_get (long id, const KURL &url, const MetaData &metaData) |
MimetypeJob * | mimetype (const KURL &url, bool showProgressInfo=true) |
FileCopyJob * | file_copy (const KURL &src, const KURL &dest, int permissions=-1, bool overwrite=false, bool resume=false, bool showProgressInfo=true) |
FileCopyJob * | file_move (const KURL &src, const KURL &dest, int permissions=-1, bool overwrite=false, bool resume=false, bool showProgressInfo=true) |
SimpleJob * | file_delete (const KURL &src, bool showProgressInfo=true) |
ListJob * | listDir (const KURL &url, bool showProgressInfo=true, bool includeHidden=true) |
ListJob * | listRecursive (const KURL &url, bool showProgressInfo=true, bool includeHidden=true) |
CopyJob * | copy (const KURL &src, const KURL &dest, bool showProgressInfo=true) |
CopyJob * | copyAs (const KURL &src, const KURL &dest, bool showProgressInfo=true) |
CopyJob * | copy (const KURL::List &src, const KURL &dest, bool showProgressInfo=true) |
CopyJob * | move (const KURL &src, const KURL &dest, bool showProgressInfo=true) |
CopyJob * | moveAs (const KURL &src, const KURL &dest, bool showProgressInfo=true) |
CopyJob * | move (const KURL::List &src, const KURL &dest, bool showProgressInfo=true) |
CopyJob * | link (const KURL &src, const KURL &destDir, bool showProgressInfo=true) |
CopyJob * | link (const KURL::List &src, const KURL &destDir, bool showProgressInfo=true) |
CopyJob * | linkAs (const KURL &src, const KURL &dest, bool showProgressInfo=true) |
DeleteJob * | del (const KURL &src, bool shred=false, bool showProgressInfo=true) |
DeleteJob * | del (const KURL::List &src, bool shred=false, bool showProgressInfo=true) |
MetaInfoJob * | fileMetaInfo (const KFileItemList &items) |
MetaInfoJob * | fileMetaInfo (const KURL::List &items) |
Job * | pasteClipboard (const KURL &_dest_url, bool move=false) |
void | pasteData (const KURL &_dest_url, const QByteArray &_data) |
CopyJob * | pasteDataAsync (const KURL &_dest_url, const QByteArray &_data) |
bool | isClipboardEmpty () |
PreviewJob * | filePreview (const KFileItemList &items, int width, int height=0, int iconSize=0, int iconAlpha=70, bool scale=true, bool save=true, const QStringList *enabledPlugins=0) |
PreviewJob * | filePreview (const KURL::List &items, int width, int height=0, int iconSize=0, int iconAlpha=70, bool scale=true, bool save=true, const QStringList *enabledPlugins=0) |
Detailed Description
A namespace for KIO globals.Typedef Documentation
|
64-bit file offset
|
|
64-bit file size
Definition at line 39 of file global.h. Referenced by KIO::PreviewJob::slotResult(). |
|
An entry is the list of atoms containing all the informations for a file or URL.
Definition at line 448 of file global.h. Referenced by KFileItem::refresh(). |
Enumeration Type Documentation
|
Commands that can be invoked by a job.
|
|
Error codes that can be emitted by KIO.
|
|
|
Specifies how to use the cache.
|
|
The result of open_RenameDlg().
Definition at line 39 of file renamedlg.h. Referenced by KIO::FileCopyJob::slotCanResume(), and KIO::CopyJob::slotResult(). |
|
Identifiers for KIO informational messages.
Definition at line 46 of file slaveinterface.h. |
|
Identifiers for KIO data messages.
Definition at line 66 of file slaveinterface.h. |
Function Documentation
|
Creates a job that changes permissions/ownership on several files or directories, optionally recursively. This version of chmod uses a KFileItemList so that it directly knows what to do with the items. TODO: a version that takes a KURL::List, and a general job that stats each url and returns a KFileItemList. Note that change of ownership is only supported for local files. Inside directories, the "x" bits will only be changed for files that had at least one "x" bit before, and for directories. This emulates the behavior of chmod +X.
Definition at line 237 of file chmodjob.cpp. References QFile::encodeName(), and QString::isEmpty(). Referenced by KFilePermissionsPropsPlugin::applyChanges(). |
|
Creates a new DavJob that issues a PROPFIND command.
PROPFIND retrieves the properties of the resource identified by the given
Definition at line 114 of file davjob.cpp. References QDomDocument::toString(). |
|
Creates a new DavJob that issues a PROPPATCH command.
PROPPATCH sets the properties of the resource identified by the given
Definition at line 122 of file davjob.cpp. References QDomDocument::toString(). |
|
Creates a new DavJob that issues a SEARCH command.
Definition at line 127 of file davjob.cpp. References QDomDocument::createElementNS(), QDomDocument::createTextNode(), and QDomDocument::toString(). |
|
Converts
Definition at line 46 of file global.cpp. References QString::arg(), and KGlobal::locale(). Referenced by convertSizeFromKB(), KFileItem::getToolTipText(), and KFileMimeTypeInfo::ItemInfo::string(). |
|
Converts a size to a string representation Not unlike QString::number(...).
Definition at line 85 of file global.cpp. References QString::fromLatin1(). Referenced by KIO::SlaveBase::canResume(), KBookmarkManager::findByAddress(), KURLBar::readItem(), KFileView::sortingKey(), and KURLBar::writeItem(). |
|
Converts size from kilo-bytes to the string representation.
Definition at line 80 of file global.cpp. References convertSize(). Referenced by KFileMimeTypeInfo::ItemInfo::string(). |
|
Calculates remaining time from total size, processed size and speed.
Definition at line 92 of file global.cpp. References QTime::setHMS(). |
|
Helper for showing information about a set of files and directories.
Definition at line 115 of file global.cpp. References QString::arg(). |
|
Encodes (from the text displayed to the real filename) This translates % into %% and / into %2f Used by KIO::link, for instance.
Definition at line 130 of file global.cpp. References QString::find(), and QString::replace(). Referenced by KFilePropsPlugin::applyChanges(). |
|
Decodes (from the filename to the text displayed) This translates %2[fF] into / and %% into %.
Definition at line 145 of file global.cpp. References QString::append(), QString::length(), and QString::lower(). Referenced by KFileItem::KFileItem(), KFilePropsPlugin::KFilePropsPlugin(), KPropertiesDialog::KPropertiesDialog(), and KFileItem::setName(). |
|
Returns a translated error message for
Definition at line 178 of file global.cpp. References QString::arg(), QString::fromLatin1(), and QString::isEmpty(). Referenced by KIO::Job::errorString(), and rawErrorDetail(). |
|
Returns a translated html error message for
|
|
Returns translated error details for
Definition at line 472 of file global.cpp. References QString::arg(), buildErrorString(), KProtocolManager::connectTimeout(), QDateTime::currentDateTime(), KURL::fileName(), KLocale::formatDateTime(), KURL::host(), QString::isNull(), QString::left(), KGlobal::locale(), QString::mid(), KURL::path(), KURL::prettyURL(), KURL::protocol(), KProtocolManager::proxyConnectTimeout(), and KProtocolManager::responseTimeout(). Referenced by KIO::Job::detailedErrorStrings(). |
|
Returns an appropriate error message if the given command
Definition at line 383 of file global.cpp. 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(). |
|
Parses the string representation of the cache control option.
Definition at line 1894 of file global.cpp. References QString::lower(). Referenced by KProtocolManager::cacheControl(). |
|
Returns a string representation of the given cache control method.
Definition at line 1913 of file global.cpp. |
|
Returns the mount point where This means, it has to be mounted, not just defined in fstab. Definition at line 1320 of file global.cpp. References QFile::encodeName(), QCString::isEmpty(), and QCString::length(). Referenced by KDEDesktopMimeType::builtinServices(), KDEDesktopMimeType::executeService(), and KDEDesktopMimeType::icon(). |
|
Returns the mount point on which resides For instance if /home is a separate partition, findPathMountPoint("/home/user/blah") will return /home
Definition at line 1850 of file global.cpp. Referenced by KDiskFreeSp::findUsageInfo(), and KFilePropsPlugin::KFilePropsPlugin(). |
|
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 1865 of file global.cpp. References QString::isNull(). |
|
Checks if the path belongs to a filesystem that is manually mounted.
Definition at line 1857 of file global.cpp. References QString::isNull(). |
|
Checks the capabilities of the filesystem to which a given file belongs. given feature (e.g. chmod).
Definition at line 1873 of file global.cpp. References QString::isNull(). |
|
Creates a single directory.
|
|
Removes a single directory. The directory is assumed to be empty.
|
|
Changes permissions on a file or directory. See the other chmod below for changing many files or directories.
|
|
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.
|
|
Create or move a symlink. This is the lowlevel operation, similar to file_copy and file_move. It doesn't do any check (other than those the slave does) and it doesn't show rename and skip dialogs - use KIO::link for that.
Definition at line 631 of file job.cpp. Referenced by KArchiveDirectory::KArchiveDirectory(), KArchiveEntry::KArchiveEntry(), KArchiveFile::KArchiveFile(), KZip::openArchive(), and KTar::openArchive(). |
|
Execute any command that is specific to one slave (protocol). Examples are : HTTP POST, mount and unmount (kio_file)
|
|
Mount filesystem.
Special job for
Definition at line 644 of file job.cpp. References QString::fromLatin1(), Observer::mounting(), Observer::self(), and special(). Referenced by KDEDesktopMimeType::builtinServices(), and KAutoMount::KAutoMount(). |
|
Unmount filesystem.
Special job for
Definition at line 654 of file job.cpp. References Observer::self(), special(), and Observer::unmounting(). Referenced by KDEDesktopMimeType::builtinServices(), and KAutoUnmount::KAutoUnmount(). |
|
HTTP cache update.
Definition at line 754 of file job.cpp. References KURL::protocol(). |
|
Find all details for one file or directory.
Definition at line 736 of file job.cpp. Referenced by KIO::CopyJob::slotResult(). |
|
Find all details for one file or directory.
This version of the call includes two additional booleans,
Definition at line 742 of file job.cpp. References KURL::prettyURL(), Observer::self(), KIO::StatJob::setDetails(), KIO::StatJob::setSide(), and Observer::stating(). |
|
Get (a.k.a. read). The slave emits the data through data().
Definition at line 1070 of file job.cpp. References KIO::Job::addMetaData(), and KStdAccel::reload(). Referenced by KIO::FileCopyJob::slotCanResume(). |
|
Put (a.k.a. write)
|
|
HTTP POST (for form data). Example: job = KIO::http_post( url, postData, false ); job->addMetaData("content-type", contentType ); job->addMetaData("referrer", referrerURL);
You MUST specify content-type!
Often
Definition at line 1093 of file job.cpp. References QValueList< int >::begin(), QValueList< int >::contains(), QValueList< int >::end(), QString::isEmpty(), KURL::path(), KURL::port(), KURL::protocol(), KURL::setPath(), QTimer::singleShot(), and KURL::url(). |
|
Creates a new mult-get job.
Definition at line 3817 of file job.cpp. References KIO::MultiGetJob::get(). |
|
Find mimetype for one file or directory.
Definition at line 1285 of file job.cpp. References Observer::self(), and Observer::stating(). Referenced by KFilterDev::device(), KFilterDev::deviceForFile(), KTar::KTar(), and KDataToolInfo::query(). |
|
Copy a single file. Uses either SlaveBase::copy() if the slave supports that or get() and put() otherwise.
|
|
Move a single file. Use either SlaveBase::rename() if the slave supports that, or copy() and del() otherwise, or eventually get() & put() & del()
|
|
Delete a single file.
Definition at line 1671 of file job.cpp. Referenced by KIO::FileCopyJob::slotResult(). |
|
List the contents of "." and ".." are returned, filter them out if you don't want them.
|
|
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.
Definition at line 1836 of file job.cpp. Referenced by KIO::DeleteJob::slotResult(). |
|
Copy a file or directory This emulates the cp command completely.
Definition at line 3160 of file job.cpp. Referenced by KFilePropsPlugin::applyChanges(), and pasteClipboard(). |
|
Copy a file or directory As opposed to copy(), this doesn't emulate cp, but is the only way to copy a directory, giving it a new name and getting an error box if a directory already exists with the same name.
|
|
Copy a list of file/dirs
|
|
Moves a file or directory
Definition at line 3181 of file job.cpp. Referenced by KFilePropsPlugin::applyChanges(), KIO::FileCopyJob::FileCopyJob(), pasteClipboard(), and pasteDataAsync(). |
|
Moves a file or directory Unlike move() this operation will fail when the directory already exists.
|
|
Moves a list of files or directories
|
|
Create a link. If the protocols and hosts are the same, a Unix symlink will be created. Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.
|
|
Create several links If the protocols and hosts are the same, a Unix symlink will be created. Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.
|
|
Create a link. Unlike link() this operation will fail when the directory already exists. If the protocols and hosts are the same, a Unix symlink will be created. Otherwise, a .desktop file of Type Link and pointing to the src URL will be created.
|
|
Delete a file or directory.
Definition at line 3635 of file job.cpp. Referenced by KDirOperator::del(). |
|
Deletes a list of files or directories.
|
|
Retrieves meta information for the given items.
Definition at line 172 of file metainfojob.cpp. |
|
Retrieves meta information for the given items.
Definition at line 177 of file metainfojob.cpp. References QPtrList< KFileItem >::append(). |
|
Pastes the content of the clipboard (e.g. URLs) to the given destination URL.
Definition at line 92 of file paste.cpp. References QTextDrag::canDecode(), QUriDrag::canDecode(), QApplication::clipboard(), copy(), QTextDrag::decode(), KURLDrag::decode(), KMessageBox::error(), KURL::isValid(), move(), pasteDataAsync(), KMessageBox::sorry(), QStringList::split(), and KURL::url(). |
|
Pastes the given
Definition at line 153 of file paste.cpp. References KTempFile::close(), KTempFile::dataStream(), KURL::isEmpty(), KTempFile::name(), KTempFile::setAutoDelete(), KIO::NetAccess::upload(), and QDataStream::writeRawBytes(). |
|
Pastes the given
Definition at line 170 of file paste.cpp. References KTempFile::close(), KTempFile::dataStream(), KURL::isEmpty(), move(), KTempFile::name(), KURL::setPath(), and QDataStream::writeRawBytes(). Referenced by pasteClipboard(). |
|
Checks whether the clipboard is empty.
Definition at line 76 of file paste.cpp. References QApplication::clipboard(), QString::contains(), QMimeSource::encodedData(), and QMimeSource::provides(). |
|
Creates a PreviewJob to generate or retrieve a preview image for the given URL.
Definition at line 498 of file previewjob.cpp. Referenced by KFileIconView::showPreviews(). |
|
Creates a PreviewJob to generate or retrieve a preview image for the given URL.
Definition at line 506 of file previewjob.cpp. References QPtrList< KFileItem >::append(). |