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 and kionetrc for automatic login purposes. An interface to kionetrc and the ftp .netrc files. 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 | DavJob |
The transfer job pumps data into and/or out of a Slave. More... | |
class | Job |
The base class for all jobs. More... | |
class | SimpleJob |
A simple job (one url and one command). More... | |
class | TransferJob |
The transfer job pumps data into and/or out of a Slave. More... | |
class | FileCopyJob |
The FileCopyJob copies data from one place to another. More... | |
class | DeleteJob |
class | MetaInfoJob |
| |
class | NetAccess |
Net Transparency, formerly provided by kfmlib, but now done with KIO::Job. Provides a synchronous interface to io jobs. More... | |
class | PasswordDialog |
A dialog for requesting a login and a password from the end user. More... | |
class | PreviewJob |
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
| |
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 (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 QValueList< UDSAtom > | UDSEntry |
An entry is the list of atoms containing all the informations for a file or URL. | |
Enumerations | |
enum | Error |
Error codes that can be emitted by KIO. More... | |
enum | UDSAtomTypes { UDS_STRING = 1 , UDS_SIZE = 8 | UDS_LONG , UDS_USER = 16 | UDS_STRING, UDS_GROUP = 32 | 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 } |
Constants used to specify the type of a KUDSAtom. More... | |
enum | CacheControl { CC_CacheOnly, CC_Cache, CC_Verify, CC_Refresh, CC_Reload } |
enum | Command |
Commands that can be invoked by a job. More... | |
enum | Info |
Identifiers for KIO informational messages. More... | |
enum | Message |
Identifiers for KIO data messages. More... | |
Functions | |
ChmodJob * | chmod (const KFileItemList &lstItems, int permissions, int mask, QString newOwner, QString newGroup, bool recursive, bool showProgressInfo=true) |
Creates a job that changes permissions/ownership on several files or directories, optionally recursively. | |
QString | convertSize (KIO::filesize_t size) |
Converts size from bytes to the string representation. | |
QString | number (KIO::filesize_t size) |
Converts a size to a string representation Not unlike QString::number(...). | |
QString | convertSizeFromKB (KIO::filesize_t kbSize) |
Converts size from kilo-bytes to the string representation. | |
QTime | calculateRemaining (KIO::filesize_t totalSize, KIO::filesize_t processedSize, KIO::filesize_t speed) |
Calculates remaining time from total size, processed size and speed. | |
QString | itemsSummaryString (uint items, uint files, uint dirs, KIO::filesize_t size, bool showSize) |
Helper for showing information about a set of files and directories items = files + dirs + number of symlinks :). | |
QString | encodeFileName (const QString &str) |
Encodes (from the text displayed to the real filename) This translates % into %% and / into %2f Used by KIO::link, for instance. | |
QString | decodeFileName (const QString &str) |
Decodes (from the filename to the text displayed) This translates %2[fF] into / and %% into %. | |
QString | findDeviceMountPoint (const QString &device) |
Returns the mount point where device is mounted right now. | |
QString | findPathMountPoint (const QString &filename) |
Returns the mount point on which resides filename . | |
bool | probably_slow_mounted (const QString &filename) |
Checks if the path belongs to a filesystem that is probably slow. | |
bool | manually_mounted (const QString &filename) |
Checks if the path belongs to a filesystem that is manually mounted. | |
SimpleJob * | mkdir (const KURL &url, int permissions=-1) |
Creates a single directory. | |
SimpleJob * | rmdir (const KURL &url) |
Removes a single directory. | |
SimpleJob * | chmod (const KURL &url, int permissions) |
Changes permissions on a file or directory. | |
SimpleJob * | rename (const KURL &src, const KURL &dest, bool overwrite) |
Rename a file or directory. | |
SimpleJob * | symlink (const QString &target, const KURL &dest, bool overwrite, bool showProgressInfo=true) |
Create or move a symlink. | |
SimpleJob * | special (const KURL &url, const QByteArray &data, bool showProgressInfo=true) |
Execute any command that is specific to one slave (protocol). | |
SimpleJob * | mount (bool ro, const char *fstype, const QString &dev, const QString &point, bool showProgressInfo=true) |
Mount filesystem. | |
SimpleJob * | unmount (const QString &point, bool showProgressInfo=true) |
Unmount filesystem. | |
SimpleJob * | http_update_cache (const KURL &url, bool no_cache, time_t expireDate) |
HTTP cache update. | |
StatJob * | stat (const KURL &url, bool showProgressInfo=true) |
Find all details for one file or directory. | |
StatJob * | stat (const KURL &url, bool sideIsSource, short int details, bool showProgressInfo=true) |
Find all details for one file or directory. | |
TransferJob * | get (const KURL &url, bool reload=false, bool showProgressInfo=true) |
Get (a.k.a. | |
TransferJob * | put (const KURL &url, int permissions, bool overwrite, bool resume, bool showProgressInfo=true) |
Put (a.k.a. | |
TransferJob * | http_post (const KURL &url, const QByteArray &postData, bool showProgressInfo=true) |
HTTP POST (for form data). | |
MimetypeJob * | mimetype (const KURL &url, bool showProgressInfo=true) |
Find mimetype for one file or directory. | |
FileCopyJob * | file_copy (const KURL &src, const KURL &dest, int permissions=-1, bool overwrite=false, bool resume=false, bool showProgressInfo=true) |
Copy a single file. | |
FileCopyJob * | file_move (const KURL &src, const KURL &dest, int permissions=-1, bool overwrite=false, bool resume=false, bool showProgressInfo=true) |
Move a single file. | |
SimpleJob * | file_delete (const KURL &src, bool showProgressInfo=true) |
Delete a single file. | |
ListJob * | listDir (const KURL &url, bool showProgressInfo=true, bool includeHidden=true) |
List the contents of url , which is assumed to be a directory. | |
ListJob * | listRecursive (const KURL &url, bool showProgressInfo=true, bool includeHidden=true) |
The same as the previous method, but recurses subdirectories. | |
CopyJob * | copy (const KURL &src, const KURL &dest, bool showProgressInfo=true) |
Copy a file or directory src into the destination @dest, which can be a file (including the final filename) or a directory (into which src will be copied). | |
CopyJob * | copyAs (const KURL &src, const KURL &dest, bool showProgressInfo=true) |
Copy a file or directory src into the destination @dest, which is the destination name in any case, even for a directory. | |
CopyJob * | copy (const KURL::List &src, const KURL &dest, bool showProgressInfo=true) |
Copy a list of file/dirs src into a destination directory dest . | |
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) |
Create a link. | |
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) |
Delete a file or directory. | |
int | matchConstraint (const ParseTreeBase *_tree, const KService::Ptr &_service, const KServiceTypeProfile::OfferList &_list) |
PreferencesReturn | matchPreferences (const ParseTreeBase *_tree, const KService::Ptr &_service, const KServiceTypeProfile::OfferList &_list) |
MetaInfoJob * | fileMetaInfo (const KFileItemList &items) |
Retrieves meta information for the given items. | |
MetaInfoJob * | fileMetaInfo (const KURL::List &items) |
Same as above, but takes a URL list instead of KFileItemList. | |
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) |
Generates or retrieves a preview image for the given URL. | |
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) |
Same as above, but takes a URL list instead of KFileItemList. |
Detailed Description
A namespace for KIO globals.Typedef Documentation
|
An entry is the list of atoms containing all the informations for a file or URL.
Definition at line 324 of file global.h. Referenced by KFileItem::refresh(). |
Enumeration Type Documentation
|
Error codes that can be emitted by KIO.
|
|
|
|
|
Commands that can be invoked by a job.
Definition at line 43 of file slaveinterface.h. |
|
Identifiers for KIO informational messages.
Definition at line 79 of file slaveinterface.h. |
|
Identifiers for KIO data messages.
Definition at line 99 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 behaviour of chmod +X.
Definition at line 230 of file chmodjob.cpp. References QFile::encodeName(), and QString::isEmpty(). Referenced by KFilePermissionsPropsPlugin::applyChanges(). |
|
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(), KIO::FileCopyJob::slotCanResume(), 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::setURL(). |
|
Returns the mount point where This means, it has to be mounted, not just defined in fstab. Definition at line 1270 of file global.cpp. References QFile::encodeName(), 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 1735 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 1748 of file global.cpp. |
|
Checks if the path belongs to a filesystem that is manually mounted.
Definition at line 1741 of file global.cpp. |
|
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 597 of file job.cpp. Referenced by 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 610 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 620 of file job.cpp. References Observer::self(), special(), and Observer::unmounting(). Referenced by KDEDesktopMimeType::builtinServices(), and KAutoUnmount::KAutoUnmount(). |
|
HTTP cache update.
Definition at line 713 of file job.cpp. References KURL::protocol(). |
|
Find all details for one file or directory.
Definition at line 695 of file job.cpp. Referenced by KPropertiesDialog::KPropertiesDialog(). |
|
Find all details for one file or directory.
This version of the call includes two additional booleans,
Definition at line 701 of file job.cpp. References KURL::prettyURL(), Observer::self(), and Observer::stating(). |
|
Get (a.k.a. read). The slave emits the data through data(). Definition at line 973 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 995 of file job.cpp. References QValueList< int >::begin(), QValueList< int >::contains(), QValueList< int >::end(), KURL::port(), KURL::protocol(), and KURL::url(). |
|
Find mimetype for one file or directory.
Definition at line 1165 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 1543 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. pass includeHidden = false to cull out UNIX hidden files/dirs (whose names start with .) |
|
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. pass includeHidden = false to cull out UNIX hidden files/dirs (whose names start with .) Definition at line 1698 of file job.cpp. Referenced by KIO::DeleteJob::slotResult(). |
|
Copy a file or directory
This emulates the Definition at line 2918 of file job.cpp. Referenced by KFilePropsPlugin::applyChanges(). |
|
Copy a file or directory
As opposed to copy, this doesn't emulate |
|
Copy a list of file/dirs
|
|
Definition at line 2939 of file job.cpp. Referenced by KFilePropsPlugin::applyChanges(). |
|
|
|
|
|
Create a link.
|
|
|
|
|
|
Delete a file or directory.
Definition at line 3391 of file job.cpp. Referenced by KDirOperator::del(). |
|
Definition at line 591 of file ktraderparsetree.cpp. References matchConstraint(). Referenced by matchConstraint(), and KTrader::query(). |
|
Definition at line 612 of file ktraderparsetree.cpp. References matchPreferences(). Referenced by matchPreferences(), and KTrader::query(). |
|
Retrieves meta information for the given items.
Definition at line 175 of file metainfojob.cpp. |
|
Same as above, but takes a URL list instead of KFileItemList.
Definition at line 180 of file metainfojob.cpp. References QPtrList< KFileItem >::append(). |
|
Generates or retrieves a preview image for the given URL.
Definition at line 506 of file previewjob.cpp. Referenced by KFileIconView::showPreviews(). |
|
Same as above, but takes a URL list instead of KFileItemList.
Definition at line 514 of file previewjob.cpp. References QPtrList< KFileItem >::append(). |