KSycocaEntry Class Reference

#include <ksycocaentry.h>

Inheritance diagram for KSycocaEntry:

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
Public Member Functions inherited from QSharedData
	QSharedData (const QSharedData &other)

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.

See also

http://techbase.kde.org/Development/Architecture/KDE3/System_Configuration_Cache

Definition at line 41 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 56 of file ksycocaentry.cpp.

bool KSycocaEntry::isDeleted

(

)

const

Returns

true if deleted

Definition at line 68 of file ksycocaentry.cpp.

bool KSycocaEntry::isSeparator

(

)

const

Returns

true, if this is a separator

Definition at line 80 of file ksycocaentry.cpp.

bool KSycocaEntry::isType

(

KSycocaType

t

)

const

Returns true if this sycoca entry is of the given type.

Definition at line 46 of file ksycocaentry.cpp.

bool KSycocaEntry::isValid

(

)

const

Returns

true if valid

Definition at line 97 of file ksycocaentry.cpp.

QString KSycocaEntry::name

(

)

const

Returns

the name of this entry

Definition at line 103 of file ksycocaentry.cpp.

QVariant KSycocaEntry::property

(

const QString &

name

)

const

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 115 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 109 of file ksycocaentry.cpp.

void KSycocaEntry::setDeleted

(

bool

deleted

)

Sets whether or not this service is deleted.

Definition at line 74 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 62 of file ksycocaentry.cpp.

KSycocaType KSycocaEntry::sycocaType

(

)

const

internal

Definition at line 51 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.

---

The documentation for this class was generated from the following files:

• ksycocaentry.h
• ksycocaentry.cpp