KSycocaEntry Class Reference

Base class for all Sycoca entries. More...

#include <ksycocaentry.h>

Inheritance diagram for KSycocaEntry:

[legend]

List of all members.

Public Types
typedef QValueList< Ptr >	List
typedef KSharedPtr< KSycocaEntry >	Ptr
Public Member Functions
QString	entryPath () const
virtual bool	isDeleted () const
virtual bool	isType (KSycocaType t) const
virtual bool	isValid () const =0
	KSycocaEntry (QDataStream &_str, int offset)
	KSycocaEntry (const QString &path)
virtual void	load (QDataStream &)=0
virtual QString	name () const =0
int	offset ()
virtual void	save (QDataStream &s)
virtual KSycocaType	sycocaType () const
Static Public Member Functions
static void	read (QDataStream &s, QStringList &list)
static void	read (QDataStream &s, QString &str)
Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Protected Attributes
bool	m_bDeleted
QString	mPath
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.

See also:

http://developer.kde.org/documentation/library/kdeqt/kde3arch/ksycoca.html

Definition at line 37 of file ksycocaentry.h.

---

Member Typedef Documentation

typedef QValueList<Ptr> KSycocaEntry::List

Definition at line 46 of file ksycocaentry.h.

typedef KSharedPtr<KSycocaEntry> KSycocaEntry::Ptr

Definition at line 45 of file ksycocaentry.h.

---

Constructor & Destructor Documentation

KSycocaEntry::KSycocaEntry

(

const QString &

path

)

[inline]

Default constructor.

Definition at line 51 of file ksycocaentry.h.

KSycocaEntry::KSycocaEntry	(	QDataStream &	_str,
		int	offset
	)			[inline]

For internal use only.

Restores itself from a stream.

Definition at line 63 of file ksycocaentry.h.

---

Member Function Documentation

QString KSycocaEntry::entryPath

(

)

const [inline]

Returns:

the path of this entry The path can be absolute or relative. The corresponding factory should know relative to what.

Definition at line 79 of file ksycocaentry.h.

virtual bool KSycocaEntry::isDeleted

(

)

const [inline, virtual]

Returns:

true if deleted

Definition at line 89 of file ksycocaentry.h.

virtual bool KSycocaEntry::isType

(

KSycocaType

t

)

const [inline, virtual]

Definition at line 41 of file ksycocaentry.h.

virtual bool KSycocaEntry::isValid

(

)

const [pure virtual]

Returns:

true if valid

virtual void KSycocaEntry::load

(

QDataStream &

)

[pure virtual]

For internal use only.

Load ourselves from the database. Don't call the parent class!

virtual QString KSycocaEntry::name

(

)

const [pure virtual]

Returns:

the name of this entry

int KSycocaEntry::offset

(

)

[inline]

For internal use only.

Returns:

the position of the entry in the sycoca file

Definition at line 95 of file ksycocaentry.h.

void KSycocaEntry::read	(	QDataStream &	s,
		QStringList &	list
	)			[static]

Definition at line 495 of file ksycoca.cpp.

void KSycocaEntry::read	(	QDataStream &	s,
		QString &	str
	)			[static]

Safe demarshalling functions.

Definition at line 470 of file ksycoca.cpp.

virtual void KSycocaEntry::save

(

QDataStream &

s

)

[inline, virtual]

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 102 of file ksycocaentry.h.

virtual KSycocaType KSycocaEntry::sycocaType

(

)

const [inline, virtual]

Definition at line 42 of file ksycocaentry.h.

void KSycocaEntry::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Definition at line 521 of file ksycoca.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

bool KSycocaEntry::m_bDeleted [protected]

Definition at line 117 of file ksycocaentry.h.

QString KSycocaEntry::mPath [protected]

Definition at line 118 of file ksycocaentry.h.

---

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

• ksycocaentry.h
• ksycocatype.h
• ksycoca.cpp