KDECore
KSycocaEntry Class Reference
Base class for all Sycoca entries. More...
#include <ksycocaentry.h>

Public Types | |
typedef QList< Ptr > | List |
typedef KSharedPtr< KSycocaEntry > | Ptr |
Public Member Functions | |
QString | entryPath () const |
bool | isDeleted () const |
bool | isSeparator () const |
bool | isType (KSycocaType t) const |
bool | isValid () const |
KSycocaEntry () | |
QString | name () const |
int | offset () const |
QVariant | property (const QString &name) const |
QStringList | propertyNames () const |
void | save (QDataStream &s) |
void | setDeleted (bool deleted) |
QString | storageId () const |
KSycocaType | sycocaType () const |
virtual | ~KSycocaEntry () |
Static Public Member Functions | |
static void | read (QDataStream &s, QStringList &list) |
static void | read (QDataStream &s, QString &str) |
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.
For internal use only.
Definition at line 41 of file ksycocaentry.h.
Member Typedef Documentation
typedef QList<Ptr> KSycocaEntry::List |
Reimplemented in KMimeType, KService, KServiceGroup, KServiceType, and KProtocolInfo.
Definition at line 62 of file ksycocaentry.h.
typedef KSharedPtr<KSycocaEntry> KSycocaEntry::Ptr |
Reimplemented in KMimeType, KService, KServiceGroup, KServiceType, and KProtocolInfo.
Definition at line 61 of file ksycocaentry.h.
Constructor & Destructor Documentation
KSycocaEntry::KSycocaEntry | ( | ) |
Definition at line 30 of file ksycocaentry.cpp.
KSycocaEntry::~KSycocaEntry | ( | ) | [virtual] |
Definition at line 40 of file ksycocaentry.cpp.
KSycocaEntry::KSycocaEntry | ( | KSycocaEntryPrivate & | d | ) | [protected] |
Definition at line 35 of file ksycocaentry.cpp.
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 103 of file ksycocaentry.cpp.
bool KSycocaEntry::isDeleted | ( | ) | const |
- Returns:
- true if deleted
Definition at line 115 of file ksycocaentry.cpp.
bool KSycocaEntry::isSeparator | ( | ) | const |
Definition at line 127 of file ksycocaentry.cpp.
bool KSycocaEntry::isType | ( | KSycocaType | t | ) | const |
internal
Definition at line 93 of file ksycocaentry.cpp.
bool KSycocaEntry::isValid | ( | ) | const |
- Returns:
- true if valid
Definition at line 150 of file ksycocaentry.cpp.
QString KSycocaEntry::name | ( | ) | const |
- Returns:
- the name of this entry
Definition at line 156 of file ksycocaentry.cpp.
int KSycocaEntry::offset | ( | ) | const |
For internal use only.
- Returns:
- the position of the entry in the sycoca file
Definition at line 132 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 168 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 162 of file ksycocaentry.cpp.
void KSycocaEntry::read | ( | QDataStream & | s, | |
QStringList & | list | |||
) | [static] |
Definition at line 70 of file ksycocaentry.cpp.
void KSycocaEntry::read | ( | QDataStream & | s, | |
QString & | str | |||
) | [static] |
void KSycocaEntry::save | ( | QDataStream & | s | ) |
For internal use only.
Save ourselves to the database. Don't forget to call the parent class first if you override this function.
Definition at line 144 of file ksycocaentry.cpp.
void KSycocaEntry::setDeleted | ( | bool | deleted | ) |
Sets whether or not this service is deleted.
Definition at line 121 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
Reimplemented in KService.
Definition at line 109 of file ksycocaentry.cpp.
KSycocaType KSycocaEntry::sycocaType | ( | ) | const |
internal
Definition at line 98 of file ksycocaentry.cpp.
Friends And Related Function Documentation
enum 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 31 of file ksycocatype.h.
Member Data Documentation
KSycocaEntryPrivate* KSycocaEntry::d_ptr [protected] |
Definition at line 150 of file ksycocaentry.h.
The documentation for this class was generated from the following files: