KSycocaEntry
#include <ksycocaentry.h>

Public Types | |
typedef QList< Ptr > | List |
typedef QExplicitlySharedDataPointer< KSycocaEntry > | Ptr |
Public Member Functions | |
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 |
![]() | |
QSharedData (const QSharedData &) | |
Protected Member Functions | |
KSycocaEntry (KSycocaEntryPrivate &d) | |
Protected Attributes | |
KSycocaEntryPrivate * | d_ptr |
Related Functions | |
(Note that these are not member functions.) | |
enum | KSycocaType |
Detailed Description
Base class for all Sycoca entries.
You can't create an instance of KSycocaEntry, but it provides the common functionality for servicetypes and services.
Definition at line 30 of file ksycocaentry.h.
Member Typedef Documentation
typedef QList<Ptr> KSycocaEntry::List |
A list of shared data pointers for KSycocaEntry.
Definition at line 57 of file ksycocaentry.h.
A shared data pointer for KSycocaEntry.
Definition at line 53 of file ksycocaentry.h.
Member Function Documentation
QString KSycocaEntry::entryPath | ( | ) | const |
- Returns
- the path of this entry The path can be absolute or relative. The corresponding factory should know relative to what.
Definition at line 45 of file ksycocaentry.cpp.
bool KSycocaEntry::isDeleted | ( | ) | const |
- Returns
- true if deleted
Definition at line 57 of file ksycocaentry.cpp.
bool KSycocaEntry::isSeparator | ( | ) | const |
- Returns
- true, if this is a separator
Definition at line 69 of file ksycocaentry.cpp.
bool KSycocaEntry::isType | ( | KSycocaType | t | ) | const |
Returns true if this sycoca entry is of the given type.
Definition at line 35 of file ksycocaentry.cpp.
bool KSycocaEntry::isValid | ( | ) | const |
- Returns
- true if valid
Definition at line 86 of file ksycocaentry.cpp.
QString KSycocaEntry::name | ( | ) | const |
- Returns
- the name of this entry
Definition at line 92 of file ksycocaentry.cpp.
Returns the requested property.
Some often used properties have convenience access functions like exec(), serviceTypes etc.
- Parameters
-
name the name of the property
- Returns
- the property, or invalid if not found
Definition at line 104 of file ksycocaentry.cpp.
QStringList KSycocaEntry::propertyNames | ( | ) | const |
Returns the list of all properties that this service can have.
That means, that some of these properties may be empty.
- Returns
- the list of supported properties
Definition at line 98 of file ksycocaentry.cpp.
void KSycocaEntry::setDeleted | ( | bool | deleted | ) |
Sets whether or not this service is deleted.
Definition at line 63 of file ksycocaentry.cpp.
QString KSycocaEntry::storageId | ( | ) | const |
- Returns
- the unique ID for this entry In practice, this is storageId() for KService and name() for everything else.
- Since
- 4.2.1
Definition at line 51 of file ksycocaentry.cpp.
KSycocaType KSycocaEntry::sycocaType | ( | ) | const |
internal
Definition at line 40 of file ksycocaentry.cpp.
Friends And Related Function Documentation
|
related |
A KSycocaType is a code (out of the KSycocaType enum) assigned to each class type derived from KSycocaEntry . To use it, call the macro K_SYCOCATYPE( your_typecode, parent_class ) at the top of your class definition.
Definition at line 19 of file ksycocatype.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Jan 23 2021 02:27:30 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.