KServiceType

#include <KServiceType>

Inheritance diagram for KServiceType:

Public Types

typedef QList< PtrList
 
typedef QExplicitlySharedDataPointer< KServiceTypePtr
 
- Public Types inherited from KSycocaEntry
typedef QList< PtrList
 
typedef QExplicitlySharedDataPointer< KSycocaEntryPtr
 

Public Member Functions

 KServiceType (KDesktopFile *config)
 
QString comment () const
 
bool inherits (const QString &servTypeName) const
 
bool isDerived () const
 
QString parentServiceType () const
 
Ptr parentType ()
 
QVariant::Type propertyDef (const QString &_name) const
 
QStringList propertyDefNames () const
 
QMap< QString, QVariant::TypepropertyDefs () const
 
int serviceOffersOffset () const
 
void setServiceOffersOffset (int offset)
 
- Public Member Functions inherited from KSycocaEntry
QString entryPath () const
 
bool isDeleted () const
 
bool isSeparator () const
 
bool isType (KSycocaType t) const
 
bool isValid () const
 
QString name () const
 
QVariant property (const QString &name) const
 
QStringList propertyNames () const
 
void setDeleted (bool deleted)
 
QString storageId () const
 
KSycocaType sycocaType () const
 
- Public Member Functions inherited from QSharedData
 QSharedData (const QSharedData &)
 

Static Public Member Functions

static List allServiceTypes ()
 
static Ptr serviceType (const QString &_name)
 

Additional Inherited Members

- Protected Member Functions inherited from KSycocaEntry
 KSycocaEntry (KSycocaEntryPrivate &d)
 
- Protected Attributes inherited from KSycocaEntry
KSycocaEntryPrivate * d_ptr
 

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 45 of file kservicetype.h.

Member Typedef Documentation

A list of shared data pointers for KServiceType.

Definition at line 55 of file kservicetype.h.

A shared data pointer for KServiceType.

Definition at line 51 of file kservicetype.h.

Constructor & Destructor Documentation

KServiceType::KServiceType ( KDesktopFile config)
explicit

Construct a service type and take all information from a desktop file.

Parameters
configthe configuration file

Definition at line 38 of file kservicetype.cpp.

Member Function Documentation

KServiceType::List KServiceType::allServiceTypes ( )
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 190 of file kservicetype.cpp.

QString KServiceType::comment ( ) const

Returns the descriptive comment associated, if any.

Returns
the comment, or QString()

Definition at line 231 of file kservicetype.cpp.

bool KServiceType::inherits ( const QString servTypeName) const

Checks whether this service type is or inherits from servTypeName.

Returns
true if this servicetype is or inherits from servTypeName

Definition at line 126 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 237 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 120 of file kservicetype.cpp.

KServiceType::Ptr KServiceType::parentType ( )

Pointer to parent service type

Definition at line 196 of file kservicetype.cpp.

QVariant::Type KServiceType::propertyDef ( const QString _name) const

Returns the type of the property definition with the given _name.

Parameters
_namethe name of the property
Returns
the property type, or null if not found
See also
propertyDefNames

Definition at line 171 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,

[PropertyDef::X-KDevelop-Version]
Type=int

means that all kdevelop plugins have in their .desktop file a line like

X-KDevelop-Version=<some value>

Definition at line 178 of file kservicetype.cpp.

QMap< QString, QVariant::Type > KServiceType::propertyDefs ( ) const

(for KBuildServiceTypeFactory)

Definition at line 243 of file kservicetype.cpp.

int KServiceType::serviceOffersOffset ( ) const

Definition at line 225 of file kservicetype.cpp.

KServiceType::Ptr KServiceType::serviceType ( const QString _name)
static

Returns a pointer to the servicetype '_name' or nullptr if the service type is unknown.

VERY IMPORTANT : don't store the result in a KServiceType * !

Parameters
_namethe name of the service type to search
Returns
the pointer to the service type, or nullptr

Definition at line 184 of file kservicetype.cpp.

void KServiceType::setServiceOffersOffset ( int  offset)

only used by kbuildsycoca Register offset into offers list

Definition at line 218 of file kservicetype.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Aug 5 2020 22:45:46 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.