KDE 3.5 API Reference kio
KDataToolInfo Class Reference
This is a convenience class for KService. More...
#include <kdatatool.h>
Public Member Functions | |
| QStringList | commands () const |
| KDataTool * | createTool (QObject *parent=0, const char *name=0) const |
| QString | dataType () const |
| QPixmap | icon () const KDE_DEPRECATED |
| QString | iconName () const |
| KInstance * | instance () const |
| bool | isReadOnly () const |
| bool | isValid () const |
| KDataToolInfo (const KDataToolInfo &info) | |
| KDataToolInfo (const KService::Ptr &service, KInstance *instance) | |
| KDataToolInfo () | |
| QStringList | mimeTypes () const |
| QPixmap | miniIcon () const KDE_DEPRECATED |
| KDataToolInfo & | operator= (const KDataToolInfo &info) |
| KService::Ptr | service () const |
| QStringList | userCommands () const |
Static Public Member Functions | |
| static QValueList< KDataToolInfo > | query (const QString &datatype, const QString &mimetype, KInstance *instance) |
Detailed Description
This is a convenience class for KService.You can use it if you have a KService describing a KDataTool. In this case the KDataToolInfo class is more convenient to work with.
Especially useful is the method createTool which creates the datatool described by the service.
- See also:
- KDataTool
Definition at line 47 of file kdatatool.h.
Constructor & Destructor Documentation
| KDataToolInfo::KDataToolInfo | ( | ) |
| KDataToolInfo::KDataToolInfo | ( | const KService::Ptr & | service, | |
| KInstance * | instance | |||
| ) |
Create a valid KDataToolInfo.
- Parameters:
-
service the corresponding service instance the instance to use
Definition at line 45 of file kdatatool.cpp.
| KDataToolInfo::KDataToolInfo | ( | const KDataToolInfo & | info | ) |
Member Function Documentation
| QStringList KDataToolInfo::commands | ( | ) | const |
Returns the list of commands the DataTool can execute.
The application passes the command to the KDataTool::run method.
This list comes from the Commands field of the tool's desktop file.
Each of the strings returned corresponds to a string in the list returned by userCommands.
- Returns:
- the list of commands the DataTool can execute, suitable for the KDataTool::run method.
Definition at line 130 of file kdatatool.cpp.
Creates the data tool described by this KDataToolInfo.
- Parameters:
-
parent the parent of the QObject (or 0 for parent-less KDataTools) name the name of the QObject, can be 0
- Returns:
- a pointer to the created data tool or 0 on error.
Definition at line 146 of file kdatatool.cpp.
| QString KDataToolInfo::dataType | ( | ) | const |
Returns the data type that the DataTool can accept.
- Returns:
- the C++ data type that this DataTool accepts. For example "QString" or "QImage" or something more complicated.
Definition at line 71 of file kdatatool.cpp.
| QPixmap KDataToolInfo::icon | ( | ) | const |
Returns the icon of this data tool.
- Returns:
- a large pixmap for the DataTool.
- Deprecated:
- , use iconName()
Definition at line 95 of file kdatatool.cpp.
| QString KDataToolInfo::iconName | ( | ) | const |
Returns the icon name for this DataTool.
- Returns:
- the name of the icon for the DataTool
Definition at line 123 of file kdatatool.cpp.
| KInstance* KDataToolInfo::instance | ( | ) | const [inline] |
| bool KDataToolInfo::isReadOnly | ( | ) | const |
Checks whether the DataTool is read-only.
- Returns:
- true if the DataTool does not modify the data passed to it by KDataTool::run.
Definition at line 87 of file kdatatool.cpp.
| bool KDataToolInfo::isValid | ( | ) | const |
A DataToolInfo may be invalid if the KService passed to its constructor does not feature the service type "KDataTool".
- Returns:
- true if valid, false otherwise
Definition at line 208 of file kdatatool.cpp.
| QStringList KDataToolInfo::mimeTypes | ( | ) | const |
Returns a list of mime type that will be accepted by the DataTool.
The mimetypes are only used if the dataType can be used to store different mimetypes. For example in a "QString" you could save "text/plain" or "text/html" or "text/xml".
- Returns:
- the mime types accepted by this DataTool. For example "image/gif" or "text/plain". In some cases the dataType determines the accepted type of data perfectly. In this cases this list may be empty.
Definition at line 79 of file kdatatool.cpp.
| QPixmap KDataToolInfo::miniIcon | ( | ) | const |
Returns the mini icon of this data tool.
- Returns:
- a mini pixmap for the DataTool.
- Deprecated:
- , use iconName()
Definition at line 109 of file kdatatool.cpp.
| KDataToolInfo & KDataToolInfo::operator= | ( | const KDataToolInfo & | info | ) |
| QValueList< KDataToolInfo > KDataToolInfo::query | ( | const QString & | datatype, | |
| const QString & | mimetype, | |||
| KInstance * | instance | |||
| ) | [static] |
Queries the KTrader about installed KDataTool implementations.
- Parameters:
-
datatype a type that the application can 'export' to the tools (e.g. QString) mimetype the mimetype of the data (e.g. text/plain) instance the application (or the part)'s instance (to check if a tool is excluded from this part, and also used if the tool wants to read its configuration in the app's config file).
- Returns:
- the list of results
Definition at line 162 of file kdatatool.cpp.
| KService::Ptr KDataToolInfo::service | ( | ) | const |
The KDataToolInfo's service that is represented by this class.
- Returns:
- the service
Definition at line 157 of file kdatatool.cpp.
| QStringList KDataToolInfo::userCommands | ( | ) | const |
Returns a list of strings that you can put in a QPopupMenu item, for example to offer the DataTools services to the user.
The returned value is usually something like "Spell checking", "Shrink Image", "Rotate Image" or something like that. This list comes from the Comment field of the tool's desktop file (so that it can be translated).
Each of the strings returned corresponds to a string in the list returned by commands.
- Returns:
- a list of strings that you can put in a QPopupMenu item
Definition at line 138 of file kdatatool.cpp.
The documentation for this class was generated from the following files:
