#include <kprotocolinfo.h>
Inherits KSycocaEntry.
Classes | |
struct | ExtraField |
Public Types | |
enum | Type { T_STREAM , T_FILESYSTEM , T_NONE , T_ERROR } |
enum | FileNameUsedForCopying { Name , FromURL } |
typedef TDESharedPtr< KProtocolInfo > | Ptr |
typedef TQValueList< ExtraField > | ExtraFieldList |
Public Member Functions | |
KProtocolInfo (const TQString &path) | |
virtual bool | isValid () const |
virtual TQString | name () const |
KProtocolInfo (TQDataStream &_str, int offset) | |
virtual void | load (TQDataStream &) |
virtual void | save (TQDataStream &) |
Static Public Member Functions | |
static TQStringList | protocols () |
static bool | isKnownProtocol (const KURL &url) |
static bool | isKnownProtocol (const TQString &protocol) |
static TQString | exec (const TQString &protocol) |
static Type | inputType (const KURL &url) |
static Type | outputType (const KURL &url) |
static TQStringList | listing (const KURL &url) |
static ExtraFieldList | extraFields (const KURL &url) |
static bool | isSourceProtocol (const KURL &url) |
static bool | isHelperProtocol (const KURL &url) |
static bool | isHelperProtocol (const TQString &protocol) |
static bool | isFilterProtocol (const KURL &url) |
static bool | isFilterProtocol (const TQString &protocol) |
static bool | supportsListing (const KURL &url) |
static bool | supportsReading (const KURL &url) |
static bool | supportsWriting (const KURL &url) |
static bool | supportsMakeDir (const KURL &url) |
static bool | supportsDeleting (const KURL &url) |
static bool | supportsLinking (const KURL &url) |
static bool | supportsMoving (const KURL &url) |
static bool | canCopyFromFile (const KURL &url) |
static bool | canCopyToFile (const KURL &url) |
static bool | canRenameFromFile (const KURL &url) |
static bool | canRenameToFile (const KURL &url) |
static bool | canDeleteRecursive (const KURL &url) |
static FileNameUsedForCopying | fileNameUsedForCopying (const KURL &url) |
static TQString | defaultMimetype (const KURL &url) |
static TQString | icon (const TQString &protocol) |
static TQString | config (const TQString &protocol) |
static int | maxSlaves (const TQString &protocol) |
static bool | determineMimetypeFromExtension (const TQString &protocol) |
static TQString | docPath (const TQString &protocol) |
static TQString | protocolClass (const TQString &protocol) |
static bool | showFilePreview (const TQString &protocol) |
static KURL::URIMode | uriParseMode (const TQString &protocol) |
static TQStringList | capabilities (const TQString &protocol) |
static TQString | proxiedBy (const TQString &protocol) |
static Type | inputType (const TQString &protocol) KDE_DEPRECATED |
static Type | outputType (const TQString &protocol) KDE_DEPRECATED |
static TQStringList | listing (const TQString &protocol) KDE_DEPRECATED |
static bool | isSourceProtocol (const TQString &protocol) KDE_DEPRECATED |
static bool | supportsListing (const TQString &protocol) KDE_DEPRECATED |
static bool | supportsReading (const TQString &protocol) KDE_DEPRECATED |
static bool | supportsWriting (const TQString &protocol) KDE_DEPRECATED |
static bool | supportsMakeDir (const TQString &protocol) KDE_DEPRECATED |
static bool | supportsDeleting (const TQString &protocol) KDE_DEPRECATED |
static bool | supportsLinking (const TQString &protocol) KDE_DEPRECATED |
static bool | supportsMoving (const TQString &protocol) KDE_DEPRECATED |
static bool | canCopyFromFile (const TQString &protocol) KDE_DEPRECATED |
static bool | canCopyToFile (const TQString &protocol) KDE_DEPRECATED |
static TQString | defaultMimetype (const TQString &protocol) KDE_DEPRECATED |
Static Protected Member Functions | |
static KProtocolInfo * | findProtocol (const KURL &url) |
Protected Attributes | |
TQString | m_name |
TQString | m_exec |
Type | m_inputType |
Type | m_outputType |
TQStringList | m_listing |
bool | m_isSourceProtocol |
bool | m_isHelperProtocol |
bool | m_supportsListing |
bool | m_supportsReading |
bool | m_supportsWriting |
bool | m_supportsMakeDir |
bool | m_supportsDeleting |
bool | m_supportsLinking |
bool | m_supportsMoving |
TQString | m_defaultMimetype |
bool | m_determineMimetypeFromExtension |
TQString | m_icon |
bool | m_canCopyFromFile |
bool | m_canCopyToFile |
TQString | m_config |
int | m_maxSlaves |
Friends | |
class | KProtocolInfoFactory |
Detailed Description
Information about I/O (Internet, etc.) protocols supported by KDE.
This class is useful if you want to know which protocols KDE supports. In addition you can find out lots of information about a certain protocol. A KProtocolInfo instance represents a single protocol. Most of the functionality is provided by the static methods that scan the *.protocol files of all installed tdeioslaves to get this information.
*.protocol files are installed in the "services" resource.
Definition at line 44 of file kprotocolinfo.h.
Member Enumeration Documentation
◆ Type
enum KProtocolInfo::Type |
Describes the type of a protocol.
Enumerator | |
---|---|
T_STREAM | protocol returns a stream |
T_FILESYSTEM | protocol describes location in a file system |
T_NONE | no information about the tyope available |
T_ERROR | used to signal an error |
Definition at line 121 of file kprotocolinfo.h.
Constructor & Destructor Documentation
◆ KProtocolInfo()
KProtocolInfo::KProtocolInfo | ( | const TQString & | path | ) |
Read a protocol description file.
- Parameters
-
path the path of the description file
Member Function Documentation
◆ canCopyFromFile() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol can copy files from the local file system
Definition at line 193 of file kprotocolinfo.cpp.
◆ canCopyFromFile() [2/2]
|
static |
◆ canCopyToFile() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol can copy files to the local file system
Definition at line 203 of file kprotocolinfo.cpp.
◆ canCopyToFile() [2/2]
|
static |
◆ canDeleteRecursive()
|
static |
Returns whether the protocol can recursively delete directories by itself.
If not (the usual case) then TDEIO 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).
- Parameters
-
url the url to check
- Returns
- true if the protocol can delete non-empty directories by itself.
- Since
- 3.4
Definition at line 231 of file kprotocolinfo.cpp.
◆ canRenameFromFile()
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol can rename/move files from the local file system
- Since
- 3.4
Definition at line 212 of file kprotocolinfo.cpp.
◆ canRenameToFile()
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol can rename files to the local file system
- Since
- 3.4
Definition at line 222 of file kprotocolinfo.cpp.
◆ capabilities()
|
static |
Returns the list of capabilities provided by the tdeioslave implementing this protocol.
This corresponds to the "Capabilities=" field in the protocol description file.
The capability names are not defined globally, they are up to each slave implementation. For example when adding support for a new special command for mounting, one would add the string "Mount" to the capabilities list, and applications could check for that string before sending a special() command that would otherwise do nothing on older tdeioslave implementations.
- Parameters
-
protocol the protocol to check
- Returns
- the list of capabilities.
- Since
- 3.3
◆ config()
|
static |
Returns the name of the config file associated with the specified protocol.
This is useful if two similar protocols need to share a single config file, e.g. http and https.
This corresponds to the "config=" field in the protocol description file. The default is the protocol name, see name()
- Parameters
-
protocol the protocol to check
- Returns
- the config file, or null if unknown
◆ defaultMimetype() [1/2]
|
static |
Returns default mimetype for this URL based on the protocol.
This corresponds to the "defaultMimetype=" field in the protocol description file.
- Parameters
-
url the url to check
- Returns
- the default mime type of the protocol, or null if unknown
Definition at line 249 of file kprotocolinfo.cpp.
◆ defaultMimetype() [2/2]
|
static |
◆ determineMimetypeFromExtension()
|
static |
Returns whether mimetypes can be determined based on extension for this protocol.
For some protocols, e.g. http, the filename extension in the URL can not be trusted to truly reflect the file type.
This corresponds to the "determineMimetypeFromExtension=" field in the protocol description file. Valid values for this field are "true" (default) or "false".
- Parameters
-
protocol the protocol to check
- Returns
- true if the mime types can be determined by extension
◆ docPath()
|
static |
Returns the documentation path for the specified protocol.
This corresponds to the "X-DocPath=" field in the protocol description file.
- Parameters
-
protocol the protocol to check
- Returns
- the docpath of the protocol, or null if unknown
- Since
- 3.2
◆ exec()
|
static |
Returns the library / executable to open for the protocol protocol
Example : "tdeio_ftp", meaning either the executable "tdeio_ftp" or the library "tdeio_ftp.la" (recommended), whichever is available.
This corresponds to the "exec=" field in the protocol description file.
- Parameters
-
protocol the protocol to check
- Returns
- the executable of library to open, or TQString::null for unsupported protocols
- See also
- KURL::protocol()
◆ extraFields()
|
static |
Definition of extra fields in the UDS entries, returned by a listDir operation.
This corresponds to the "ExtraNames=" and "ExtraTypes=" fields in the protocol description file. Those two lists should be separated with ',' in the protocol description file. See ExtraField for details about names and types
- Since
- 3.2
◆ fileNameUsedForCopying()
|
static |
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 ioslave displays names that are different from the filename of the URL (e.g. tdeio_fonts shows Arial for arial.ttf, or tdeio_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).
- Parameters
-
url the url to check
- Returns
- how to generate the filename in the destination directory when copying/moving
- Since
- 3.4
Definition at line 240 of file kprotocolinfo.cpp.
◆ icon()
|
static |
Returns the name of the icon, associated with the specified protocol.
This corresponds to the "Icon=" field in the protocol description file.
- Parameters
-
protocol the protocol to check
- Returns
- the icon of the protocol, or null if unknown
◆ inputType() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- the input type of the given
url
Definition at line 51 of file kprotocolinfo.cpp.
◆ inputType() [2/2]
|
static |
◆ isFilterProtocol() [1/2]
|
static |
Returns whether the protocol can act as a filter protocol.
A filter protocol can operate on data that is passed to it but does not retrieve/store data itself, like gzip. A filter protocol is the opposite of a source protocol.
The "source=" field in the protocol description file determines whether a protocol is a source protocol or a filter protocol. Valid values for this field are "true" (default) for source protocol or "false" for filter protocol.
- Parameters
-
url the url to check
- Returns
- true if the protocol is a filter (e.g. gzip), false if the protocol is a helper or source
Definition at line 79 of file kprotocolinfo.cpp.
◆ isFilterProtocol() [2/2]
|
static |
Same as above except you can supply just the protocol instead of the whole URL.
Definition at line 84 of file kprotocolinfo.cpp.
◆ isHelperProtocol() [1/2]
|
static |
Returns whether the protocol can act as a helper protocol.
A helper protocol invokes an external application and does not return a file or stream.
This corresponds to the "helper=" field in the protocol description file. Valid values for this field are "true" or "false" (default).
- Parameters
-
url the url to check
- Returns
- true if the protocol is a helper protocol (e.g. vnc), false if not (e.g. http)
Definition at line 94 of file kprotocolinfo.cpp.
◆ isHelperProtocol() [2/2]
|
static |
Same as above except you can supply just the protocol instead of the whole URL.
Definition at line 99 of file kprotocolinfo.cpp.
◆ isKnownProtocol() [1/2]
|
static |
Returns whether a protocol is installed that is able to handle url
.
- Parameters
-
url the url to check
- Returns
- true if the protocol is known
- See also
- name()
Definition at line 109 of file kprotocolinfo.cpp.
◆ isKnownProtocol() [2/2]
|
static |
Same as above except you can supply just the protocol instead of the whole URL.
Definition at line 114 of file kprotocolinfo.cpp.
◆ isSourceProtocol() [1/2]
|
static |
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.
- Parameters
-
url the url to check
- Returns
- true if the protocol is a source of data (e.g. http), false if the protocol is a filter (e.g. gzip)
Definition at line 70 of file kprotocolinfo.cpp.
◆ isSourceProtocol() [2/2]
|
static |
◆ isValid()
|
inlinevirtual |
Returns whether the protocol description file is valid.
- Returns
- true if valid, false otherwise
Definition at line 64 of file kprotocolinfo.h.
◆ listing() [1/2]
|
static |
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.
- Parameters
-
url the url to check
- Returns
- a list of field names
Definition at line 130 of file kprotocolinfo.cpp.
◆ listing() [2/2]
|
static |
- Deprecated:
- 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
◆ maxSlaves()
|
static |
Returns the soft limit on the number of slaves for this protocol.
This limits the number of slaves used for a single operation, note that multiple operations may result in a number of instances that exceeds this soft limit.
This corresponds to the "maxInstances=" field in the protocol description file. The default is 1.
- Parameters
-
protocol the protocol to check
- Returns
- the maximum number of slaves, or 1 if unknown
◆ name()
|
inlinevirtual |
Returns the name of the protocol.
This corresponds to the "protocol=" field in the protocol description file.
- Returns
- the name of the protocol
- See also
- KURL::protocol()
Definition at line 74 of file kprotocolinfo.h.
◆ outputType() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- the output type of the given
url
Definition at line 60 of file kprotocolinfo.cpp.
◆ outputType() [2/2]
|
static |
◆ protocolClass()
|
static |
Returns the protocol class for the specified protocol.
This corresponds to the "Class=" field in the protocol description file.
The following classes are defined:
- ":internet" for common internet protocols
- ":local" for protocols that access local resources
Protocol classes always start with a ':' so that they can not be confused with the protocols themselves.
- Parameters
-
protocol the protocol to check
- Returns
- the class of the protocol, or null if unknown
- Since
- 3.2
◆ protocols()
|
static |
Returns list of all known protocols.
- Returns
- a list of all known protocols
◆ proxiedBy()
|
static |
Returns the name of the protocol through which the request will be routed if proxy support is enabled.
A good example of this is the ftp protocol for which proxy support is commonly handled by the http protocol.
This corresponds to the "ProxiedBy=" in the protocol description file.
- Since
- 3.3
◆ showFilePreview()
|
static |
Returns whether file previews should be shown for the specified protocol.
This corresponds to the "ShowPreviews=" field in the protocol description file.
By default previews are shown if protocolClass is :local.
- Parameters
-
protocol the protocol to check
- Returns
- true if previews should be shown by default, false otherwise
- Since
- 3.2
◆ supportsDeleting() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol supports deleting
Definition at line 166 of file kprotocolinfo.cpp.
◆ supportsDeleting() [2/2]
|
static |
◆ supportsLinking() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol supports linking
Definition at line 175 of file kprotocolinfo.cpp.
◆ supportsLinking() [2/2]
|
static |
◆ supportsListing() [1/2]
|
static |
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.)
- Parameters
-
url the url to check
- Returns
- true if the protocol support listing
- See also
- listing()
Definition at line 121 of file kprotocolinfo.cpp.
◆ supportsListing() [2/2]
|
static |
◆ supportsMakeDir() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol can create directories
Definition at line 157 of file kprotocolinfo.cpp.
◆ supportsMakeDir() [2/2]
|
static |
◆ supportsMoving() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol supports moving
Definition at line 184 of file kprotocolinfo.cpp.
◆ supportsMoving() [2/2]
|
static |
◆ supportsReading() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if it is possible to read from the URL
Definition at line 139 of file kprotocolinfo.cpp.
◆ supportsReading() [2/2]
|
static |
◆ supportsWriting() [1/2]
|
static |
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).
- Parameters
-
url the url to check
- Returns
- true if the protocol supports writing
Definition at line 148 of file kprotocolinfo.cpp.
◆ supportsWriting() [2/2]
|
static |
◆ uriParseMode()
|
static |
Returns the suggested URI parsing mode for the KURL parser.
This corresponds to the "URIMode=" field in the protocol description file.
The following parsing modes are defined:
- "url" for a standards compliant URL
- "rawuri" for a non-conformant URI for which URL parsing would be meaningless
- "mailto" for a mailto style URI (the path part contains only an email address)
- Parameters
-
protocol the protocol to check
- Returns
- the suggested parsing mode, or KURL::Auto if unspecified
- Since
- 3.2
The documentation for this class was generated from the following files: