Member Function Documentation

[static] bool KProtocolManager::autoResume()

Returns true if partial downloads should be automatically resumed. @return true to resume partial downloads

[static] bool KProtocolManager::canCopyFromFile(const QUrl &url)

Returns whether the protocol can copy files/objects directly from the filesystem itself. If not, the application will read files from the filesystem using the file-protocol and pass the data on to the destination protocol.

This corresponds to the "copyFromFile=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol can copy files from the local file system

[static] bool KProtocolManager::canCopyToFile(const QUrl &url)

Returns whether the protocol can copy files/objects directly to the filesystem itself. If not, the application will receive the data from the source protocol and store it in the filesystem using the file-protocol.

This corresponds to the "copyToFile=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol can copy files to the local file system

[static] bool KProtocolManager::canDeleteRecursive(const QUrl &url)

Returns whether the protocol can recursively delete directories by itself. If not (the usual case) then KIO will list the directory and delete files and empty directories one by one.

This corresponds to the "deleteRecursive=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol can delete non-empty directories by itself.

[static] bool KProtocolManager::canRenameFromFile(const QUrl &url)

Returns whether the protocol can rename (i.e. move fast) files/objects directly from the filesystem itself. If not, the application will read files from the filesystem using the file-protocol and pass the data on to the destination protocol.

This corresponds to the "renameFromFile=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol can rename/move files from the local file system

[static] bool KProtocolManager::canRenameToFile(const QUrl &url)

Returns whether the protocol can rename (i.e. move fast) files/objects directly to the filesystem itself. If not, the application will receive the data from the source protocol and store it in the filesystem using the file-protocol.

This corresponds to the "renameToFile=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol can rename files to the local file system

[static] QString KProtocolManager::charsetFor(const QUrl &url)

Returns the charset to use for the specified @ref url.

[static] int KProtocolManager::connectTimeout()

Returns the preferred timeout value for remote connections in seconds.

@return timeout value for remote connection in secs.

[static] QString KProtocolManager::defaultMimetype(const QUrl &url)

Returns default MIME type for this URL based on the protocol.

This corresponds to the "defaultMimetype=" field in the protocol description file.

@param url the url to check @return the default MIME type of the protocol, or an empty string if unknown

[static] KProtocolInfo::FileNameUsedForCopying KProtocolManager::fileNameUsedForCopying(const QUrl &url)

This setting defines the strategy to use for generating a filename, when copying a file or directory to another directory. By default the destination filename is made out of the filename in the source URL. However if the KIO worker displays names that are different from the filename of the URL (e.g. kio_fonts shows Arial for arial.ttf, or kio_trash shows foo.txt and uses some internal URL), using Name means that the display name (UDS_NAME) will be used to as the filename in the destination directory.

This corresponds to the "fileNameUsedForCopying=" field in the protocol description file. Valid values for this field are "Name" or "FromURL" (default).

@param url the url to check @return how to generate the filename in the destination directory when copying/moving

[static] KProtocolInfo::Type KProtocolManager::inputType(const QUrl &url)

Returns whether the protocol should be treated as a filesystem or as a stream when reading from it.

This corresponds to the "input=" field in the protocol description file. Valid values for this field are "filesystem", "stream" or "none" (default).

@param url the url to check @return the input type of the given @p url

[static] bool KProtocolManager::isSourceProtocol(const QUrl &url)

Returns whether the protocol can act as a source protocol.

A source protocol retrieves data from or stores data to the location specified by a URL. A source protocol is the opposite of a filter protocol.

The "source=" field in the protocol description file determines whether a protocol is a source protocol or a filter protocol. @param url the url to check @return true if the protocol is a source of data (e.g. http), false if the protocol is a filter (e.g. gzip)

[static] QStringList KProtocolManager::listing(const QUrl &url)

Returns the list of fields this protocol returns when listing The current possibilities are Name, Type, Size, Date, AccessDate, Access, Owner, Group, Link, URL, MimeType as well as Extra1, Extra2 etc. for extra fields (see extraFields).

This corresponds to the "listing=" field in the protocol description file. The supported fields should be separated with ',' in the protocol description file.

@param url the url to check @return a list of field names

[static] bool KProtocolManager::markPartial()

Returns true if partial downloads should be marked with a ".part" extension. @return true if partial downloads should get an ".part" extension

[static] int KProtocolManager::minimumKeepSize()

Returns the minimum file size for keeping aborted downloads.

Any data downloaded that does not meet this minimum requirement will simply be discarded. The default size is 5 KB.

@return the minimum keep size for aborted downloads in bytes

[static] KProtocolInfo::Type KProtocolManager::outputType(const QUrl &url)

Returns whether the protocol should be treated as a filesystem or as a stream when writing to it.

This corresponds to the "output=" field in the protocol description file. Valid values for this field are "filesystem", "stream" or "none" (default).

@param url the url to check @return the output type of the given @p url

[static] QString KProtocolManager::protocolForArchiveMimetype(const QString &mimeType)

Returns which protocol handles this MIME type, if it's an archive MIME type. For instance zip:/ handles application/x-zip.

This is defined in the protocol description file using an entry like "archiveMimetype=application/x-zip"

@param mimeType the MIME type to check @return the protocol that can handle this archive MIME type, for instance "zip".

[static] int KProtocolManager::proxyConnectTimeout()

Returns the preferred timeout value for proxy connections in seconds.

@return timeout value for proxy connection in secs.

[static] int KProtocolManager::readTimeout()

Returns the preferred timeout value for reading from remote connections in seconds.

@return timeout value for remote connection in secs.

[static] void KProtocolManager::reparseConfiguration()

Force a reload of the general config file of KIO workers ( kioslaverc).

[static] int KProtocolManager::responseTimeout()

Returns the preferred response timeout value for remote connecting in seconds.

@return timeout value for remote connection in seconds.

[static] bool KProtocolManager::supportsDeleting(const QUrl &url)

Returns whether the protocol can delete files/objects.

This corresponds to the "deleting=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol supports deleting

[static] bool KProtocolManager::supportsLinking(const QUrl &url)

Returns whether the protocol can create links between files/objects.

This corresponds to the "linking=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol supports linking

[static] bool KProtocolManager::supportsListing(const QUrl &url)

Returns whether the protocol can list files/objects. If a protocol supports listing it can be browsed in e.g. file-dialogs and konqueror.

Whether a protocol supports listing is determined by the "listing=" field in the protocol description file. If the protocol support listing it should list the fields it provides in this field. If the protocol does not support listing this field should remain empty (default.)

@param url the url to check @return true if the protocol support listing @see listing()

[static] bool KProtocolManager::supportsMakeDir(const QUrl &url)

Returns whether the protocol can create directories/folders.

This corresponds to the "makedir=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol can create directories

[static] bool KProtocolManager::supportsMoving(const QUrl &url)

Returns whether the protocol can move files/objects between different locations.

This corresponds to the "moving=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol supports moving

[static] bool KProtocolManager::supportsOpening(const QUrl &url)

Returns whether the protocol can be opened using KIO::open(const QUrl&).

This corresponds to the "opening=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol supports opening

[static] bool KProtocolManager::supportsPermissions(const QUrl &url)

@brief Returns whether the protocol suppports KIO/POSIX permissions handling.

When this is false the Permissions properties tab may be hidden, for example. The protocol may still support permission control through other means, specific to the individual KIO worker.

@param url the url to check @return whether the protocol supports permissions @since 5.98

[static] bool KProtocolManager::supportsReading(const QUrl &url)

Returns whether the protocol can retrieve data from URLs.

This corresponds to the "reading=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if it is possible to read from the URL

[static] bool KProtocolManager::supportsTruncating(const QUrl &url)

Returns whether the protocol can be truncated with FileJob::truncate(KIO::filesize_t length).

This corresponds to the "truncating=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol supports truncating @since 5.66

[static] bool KProtocolManager::supportsWriting(const QUrl &url)

Returns whether the protocol can store data to URLs.

This corresponds to the "writing=" field in the protocol description file. Valid values for this field are "true" or "false" (default).

@param url the url to check @return true if the protocol supports writing