class KProtocolInfo

Public Types

• typedef KSharedPtr Ptr
• enum Type { T_STREAM, T_FILESYSTEM, T_NONE, T_ERROR }

Public Methods

•  KProtocolInfo ( const QString & path)
• virtual bool  isValid () const
• virtual QString  name () const
•  KProtocolInfo ( QDataStream& _str, int offset)
• virtual  ~KProtocolInfo ()
• virtual void  load (QDataStream& )
• virtual void  save (QDataStream& )

Public Static Methods

• static QStringList  protocols ()
• static bool  isKnownProtocol ( const KURL &url )
• static QString  exec ( const QString& protocol )
• static Type  inputType ( const KURL &url )
• static Type  outputType ( const KURL &url )
• static QStringList  listing ( const KURL &url )
• static bool  isSourceProtocol ( const KURL &url )
• static bool  isHelperProtocol ( const KURL &url )
• static bool  isFilterProtocol ( const KURL &url )
• 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 QString  defaultMimetype ( const KURL& url )
• static QString  icon ( const QString& protocol )
• static QString  config ( const QString& protocol )
• static int  maxSlaves ( const QString& protocol )
• static bool  determineMimetypeFromExtension ( const QString &protocol )
• static Type  inputType ( const QString& protocol )
• static Type  outputType ( const QString& protocol )
• static QStringList  listing ( const QString& protocol )
• static bool  isSourceProtocol ( const QString& protocol )
• static bool  isHelperProtocol ( const QString& protocol )
• static bool  isFilterProtocol ( const QString& protocol )
• static bool  isKnownProtocol ( const QString& protocol )
• static bool  supportsListing ( const QString& protocol )
• static bool  supportsReading ( const QString& protocol )
• static bool  supportsWriting ( const QString& protocol )
• static bool  supportsMakeDir ( const QString& protocol )
• static bool  supportsDeleting ( const QString& protocol )
• static bool  supportsLinking ( const QString& protocol )
• static bool  supportsMoving ( const QString& protocol )
• static bool  canCopyFromFile ( const QString& protocol )
• static bool  canCopyToFile ( const QString& protocol )
• static QString  defaultMimetype ( const QString& protocol)

Protected Methods

• virtual void  virtual_hook ( int id, void* data )

Protected Members

• QString m_name
• QString m_exec
• Type m_inputType
• Type m_outputType
• QStringList 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
• QString m_defaultMimetype
• bool m_determineMimetypeFromExtension
• QString m_icon
• bool m_canCopyFromFile
• bool m_canCopyToFile
• QString m_config
• int m_maxSlaves

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. KProtocolInfo scans the *.protocol files of all installed kioslaves to get this information.

*.protocol files are installed in the "services" resource.

Read a protocol description file

[const virtual]

Returns: whether the protocol description file is valid.

Reimplemented from KSycocaEntry.

[const virtual]

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

Returns: the name of the protocol.

See also: KURL::protocol()

Reimplemented from KSycocaEntry.

[static]

Returns: list of all known protocols

[static]

Returns: whether a protocol is installed that is able to handle url.

See also: name()

[static]

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

Returns: the library / executable to open for the protocol protocol Example : "kio_ftp", meaning either the executable "kio_ftp" or the library "kio_ftp.la" (recommended), whichever is available.

[static]

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

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

[static]

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

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

[static]

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

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

[static]

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.

Returns: whether the protocol can act as a source protocol. TODO: What does that mean? Obsolete? 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.

[static]

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

Returns: whether the protocol can act as a helper protocol. TODO: What does that mean?

[static]

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.

Returns: whether the protocol can act as a filter protocol. TODO: What does that mean? A filter protocol can operate on data that is passed to it but does not retrieve/store data itself. A filter protocol is the opposite of a source protocol.

[static]

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.)

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

See also: listing()

[static]

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

Returns: whether the protocol can retrieve data from URLs.

[static]

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

Returns: whether the protocol can store data to URLs.

[static]

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

Returns: whether the protocol can create directories/folders.

[static]

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

Returns: whether the protocol can delete files/objects.

[static]

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

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

[static]

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

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

[static]

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

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.

[static]

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

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.

[static]

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

Returns: default mimetype for this URL based on the protocol

[static]

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

Returns: the name of the icon, associated with the specified protocol

[static]

This corresponds to the "config=" field in the protocol description file. The default is the protocol name, see name()

Returns: the name of the config file associated with the specified protocol. This is usefull if two similar protocols need to share a single config file, e.g. http and https.

[static]

This corresponds to the "maxInstances=" field in the protocol description file. The default is 1.

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.

[static]

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

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.

[virtual]

[virtual]

Load the protocol info from a stream.

Reimplemented from KSycocaEntry.

[virtual]

Save the protocol info to a stream.

Reimplemented from KSycocaEntry.

[static]

[static]

[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

[static]

[static]

[static]

[static]

[static]

[static]

[static]

[static]

[static]

[static]

[static]

[static]

[static]

[static]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected]

[protected virtual]

Reimplemented from KSycocaEntry.

• Author: Torben Weis
• Generated: dfaure on faure on Tue Apr 16 08:49:48 2002, using kdoc 2.0a53.