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 | |
KSERVICE_NO_EXPORT | KSycocaEntry (KSycocaEntryPrivate &d) |
Protected Attributes | |
const std::unique_ptr< 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 32 of file ksycocaentry.h.
Member Typedef Documentation
◆ List
typedef QList<Ptr> KSycocaEntry::List |
A list of shared data pointers for KSycocaEntry.
Definition at line 58 of file ksycocaentry.h.
◆ Ptr
A shared data pointer for KSycocaEntry.
Definition at line 54 of file ksycocaentry.h.
Member Function Documentation
◆ entryPath()
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 43 of file ksycocaentry.cpp.
◆ isDeleted()
bool KSycocaEntry::isDeleted | ( | ) | const |
- Returns
- true if deleted
Definition at line 55 of file ksycocaentry.cpp.
◆ isSeparator()
bool KSycocaEntry::isSeparator | ( | ) | const |
- Returns
- true, if this is a separator
Definition at line 67 of file ksycocaentry.cpp.
◆ isType()
bool KSycocaEntry::isType | ( | KSycocaType | t | ) | const |
Returns true if this sycoca entry is of the given type.
Definition at line 33 of file ksycocaentry.cpp.
◆ isValid()
bool KSycocaEntry::isValid | ( | ) | const |
- Returns
- true if valid
Definition at line 84 of file ksycocaentry.cpp.
◆ name()
QString KSycocaEntry::name | ( | ) | const |
- Returns
- the name of this entry
Definition at line 90 of file ksycocaentry.cpp.
◆ property()
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 102 of file ksycocaentry.cpp.
◆ propertyNames()
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 96 of file ksycocaentry.cpp.
◆ setDeleted()
void KSycocaEntry::setDeleted | ( | bool | deleted | ) |
Sets whether or not this service is deleted.
Definition at line 61 of file ksycocaentry.cpp.
◆ storageId()
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 49 of file ksycocaentry.cpp.
◆ sycocaType()
KSycocaType KSycocaEntry::sycocaType | ( | ) | const |
internal
Definition at line 38 of file ksycocaentry.cpp.
Friends And Related Function Documentation
◆ KSycocaType
|
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-2023 The KDE developers.
Generated on Tue Nov 28 2023 03:55:27 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.