class KSycocaFactory

# class KSycocaFactory | More...
Internal Use Only
Contains pure virtuals
Definition | `#include <ksycocafactory.h>`
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- virtual KSycocaFactoryId factoryId () const
- virtual ~KSycocaFactory ()
- int offset ()
- KSycocaEntryDict * entryDict ()
- virtual KSycocaEntry * createEntry (const QString &file, const char *resource)
- virtual void addEntry (KSycocaEntry *newEntry, const char *resource)
- virtual KSycocaEntry * createEntry (int offset)
- KSycocaEntry::List allEntries ()
- virtual void save (QDataStream &str)
- virtual void saveHeader (QDataStream &str)
- virtual const KSycocaResourceList * resourceList () const

#### Protected Methods

- KSycocaFactory ( KSycocaFactoryId factory_id )
- virtual void virtual_hook ( int id, void* data )

#### Protected Members

- int m_sycocaDictOffset
- int m_beginEntryOffset
- int m_endEntryOffset
- QDataStream *m_str
- KSycocaResourceList *m_resourceList
- KSycocaEntryDict *m_entryDict
- KSycocaDict *m_sycocaDict

## Detailed Description

Base class for sycoca factories

KSycocaFactoryId factoryId () | ### factoryId

[const pure virtual]

KSycocaFactory ( KSycocaFactoryId factory_id ) | ### KSycocaFactory

[protected]

Create a factory which can be used to lookup from/create a database (depending on KSycoca::isBuilding())

~KSycocaFactory () | ### ~KSycocaFactory

[virtual]

int offset () | ### offset

Returns: the position of the factory in the sycoca file

KSycocaEntryDict * entryDict () | ### entryDict

Returns: the dict, for special use by KBuildSycoca

KSycocaEntry * createEntry (const QString &file, const char *resource) | ### createEntry

[pure virtual]

Construct an entry from a config file. To be implemented in the real factories.

void addEntry (KSycocaEntry *newEntry, const char *resource) | ### addEntry

[virtual]

Add an entry

KSycocaEntry * createEntry (int offset) | ### createEntry

[pure virtual]

Read an entry from the database

KSycocaEntry::List allEntries () | ### allEntries

Get a list of all entries from the database.

void save (QDataStream &str) | ### save

[virtual]

Saves all entries it maintains as well as index files for these entries to the stream 'str'.

Also sets mOffset to the starting position.

The stream is positioned at the end of the last index.

Don't forget to call the parent first when you override this function.

void saveHeader (QDataStream &str) | ### saveHeader

[virtual]

Writes out a header to the stream 'str'. The baseclass positions the stream correctly.

Don't forget to call the parent first when you override this function.

const KSycocaResourceList * resourceList () | ### resourceList

[const virtual]

Returns: the resources for which this factory is responsible.

int m_sycocaDictOffset | ### m_sycocaDictOffset

[protected]

int m_beginEntryOffset | ### m_beginEntryOffset

[protected]

int m_endEntryOffset | ### m_endEntryOffset

[protected]

QDataStream * m_str | ### m_str

[protected]

KSycocaResourceList * m_resourceList | ### m_resourceList

[protected]

KSycocaEntryDict * m_entryDict | ### m_entryDict

[protected]

KSycocaDict * m_sycocaDict | ### m_sycocaDict

[protected]

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:15 2003, using kdoc 2.0a54.