KDECore
#include <kservicetype.h>
Public Types | |
typedef QList< Ptr > | List |
typedef KSharedPtr< KServiceType > | Ptr |
Public Types inherited from KSycocaEntry | |
typedef QList< Ptr > | List |
typedef KSharedPtr< KSycocaEntry > | Ptr |
Static Public Member Functions | |
static List | allServiceTypes () |
static Ptr | serviceType (const QString &_name) |
Static Public Member Functions inherited from KSycocaEntry | |
static void | read (QDataStream &s, QString &str) |
static void | read (QDataStream &s, QStringList &list) |
Protected Member Functions | |
KServiceType (KServiceTypePrivate &dd) | |
KServiceType (KServiceTypePrivate &dd, const QString &_name, const QString &_comment) | |
Protected Member Functions inherited from KSycocaEntry | |
KSycocaEntry (KSycocaEntryPrivate &d) | |
Additional Inherited Members | |
Protected Attributes inherited from KSycocaEntry | |
KSycocaEntryPrivate * | d_ptr |
Related Functions inherited from KSycocaEntry | |
enum | KSycocaType |
Detailed Description
A service type is, well, a type of service, where a service is an application or plugin.
For instance, "KOfficeFilter", which is the type of all koffice filters, is a service type. In order to discover services of a given type, using KServiceTypeTrader. Service types are stored as desktop files in $KDEDIR/share/servicetypes.
- See also
- KService, KServiceTypeTrader
Definition at line 43 of file kservicetype.h.
Member Typedef Documentation
typedef QList<Ptr> KServiceType::List |
Definition at line 47 of file kservicetype.h.
typedef KSharedPtr<KServiceType> KServiceType::Ptr |
Definition at line 46 of file kservicetype.h.
Constructor & Destructor Documentation
|
explicit |
Construct a service type and take all information from a desktop file.
- Parameters
-
config the configuration file
Definition at line 46 of file kservicetype.cpp.
KServiceType::KServiceType | ( | QDataStream & | _str, |
int | offset | ||
) |
construct a service from a stream. The stream must already be positionned at the correct offset
Definition at line 94 of file kservicetype.cpp.
|
virtual |
Definition at line 127 of file kservicetype.cpp.
|
protected |
Construct a servicetype from another servicetype's private object.
- Parameters
-
dd the private object
Definition at line 101 of file kservicetype.cpp.
|
protected |
Construct a servicetype based on another servicetype's private object.
Allows the name and comment to be overridden.
- Parameters
-
dd the private object _name the name of the service type _comment a comment (can be empty)
Definition at line 37 of file kservicetype.cpp.
Member Function Documentation
|
static |
Returns a list of all the supported servicetypes.
Useful for showing the list of available servicetypes in a listbox, for example. More memory consuming than the ones above, don't use unless really necessary.
- Returns
- the list of all services
Definition at line 196 of file kservicetype.cpp.
QString KServiceType::comment | ( | ) | const |
Returns the descriptive comment associated, if any.
- Returns
- the comment, or QString()
Definition at line 232 of file kservicetype.cpp.
QString KServiceType::desktopEntryPath | ( | ) | const |
Returns the relative path to the desktop entry file responsible for this servicetype.
For instance inode/directory.desktop, or kpart.desktop
- Returns
- the path of the desktop file
Definition at line 240 of file kservicetype.cpp.
Checks whether this service type is or inherits from servTypeName
.
- Returns
- true if this servicetype is or inherits from
servTypeName
Definition at line 137 of file kservicetype.cpp.
bool KServiceType::isDerived | ( | ) | const |
Checks whether this service type inherits another one.
- Returns
- true if this service type inherits another one
- See also
- parentServiceType()
Definition at line 246 of file kservicetype.cpp.
QString KServiceType::parentServiceType | ( | ) | const |
If this service type inherits from another service type, return the name of the parent.
- Returns
- the parent service type, or QString:: null if not set
- See also
- isDerived()
Definition at line 131 of file kservicetype.cpp.
KServiceType::Ptr KServiceType::parentType | ( | ) |
Pointer to parent service type
Definition at line 201 of file kservicetype.cpp.
QVariant::Type KServiceType::propertyDef | ( | const QString & | _name | ) | const |
Returns the type of the property definition with the given _name
.
- Parameters
-
_name the name of the property
- Returns
- the property type, or null if not found
- See also
- propertyDefNames
Definition at line 178 of file kservicetype.cpp.
QStringList KServiceType::propertyDefNames | ( | ) | const |
Returns the list of all property definitions for this servicetype.
Those are properties of the services implementing this servicetype. For instance,
means that all kdevelop plugins have in their .desktop file a line like
Definition at line 185 of file kservicetype.cpp.
(for KBuildServiceTypeFactory)
Definition at line 252 of file kservicetype.cpp.
int KServiceType::serviceOffersOffset | ( | ) | const |
Definition at line 226 of file kservicetype.cpp.
|
static |
Returns a pointer to the servicetype '_name' or 0L if the service type is unknown.
VERY IMPORTANT : don't store the result in a KServiceType * !
- Parameters
-
_name the name of the service type to search
- Returns
- the pointer to the service type, or 0
Definition at line 191 of file kservicetype.cpp.
void KServiceType::setServiceOffersOffset | ( | int | offset | ) |
only used by kbuildsycoca Register offset into offers list
Definition at line 219 of file kservicetype.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:47:11 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.