KSycoca Class Reference

#include <ksycoca.h>

Inheritance diagram for KSycoca:

[legend]

List of all members.

---

Detailed Description

Definition at line 53 of file ksycoca.h.

Public Types
enum	DatabaseType { LocalDatabase, GlobalDatabase }
Signals
void	databaseChanged ()
Public Member Functions
void	addFactory (KSycocaFactory *)
QStringList	allResourceDirs ()
void	disableAutoRebuild ()
QDataStream *	findEntry (int offset, KSycocaType &type)
QDataStream *	findFactory (KSycocaFactoryId id)
virtual bool	isBuilding ()
QString	kfsstnd_prefixes ()
	KSycoca ()
QString	language ()
quint32	timeStamp ()
quint32	updateSignature ()
virtual	~KSycoca ()
Static Public Member Functions
static QString	absoluteFilePath (DatabaseType type=LocalDatabase)
static void	flagError ()
static bool	isAvailable ()
static bool	isChanged (const char *type)
static bool	readError ()
static KSycoca *	self ()
static int	version ()
Protected Member Functions
KSycocaFactoryList *	factories ()
	KSycoca (bool)
Protected Attributes
QDataStream *	m_str

---

Member Enumeration Documentation

enum KSycoca::DatabaseType

type of database

See also:

absoluteFilePath()

Enumerator:

LocalDatabase
GlobalDatabase

Definition at line 70 of file ksycoca.h.

---

Constructor & Destructor Documentation

KSycoca::KSycoca

(

bool

)

[explicit, protected]

Definition at line 256 of file ksycoca.cpp.

KSycoca::KSycoca

(

)

Read-only database.

Definition at line 135 of file ksycoca.cpp.

KSycoca::~KSycoca

(

)

[virtual]

Definition at line 274 of file ksycoca.cpp.

---

Member Function Documentation

QString KSycoca::absoluteFilePath

(

DatabaseType

type = LocalDatabase

)

[static]

Definition at line 501 of file ksycoca.cpp.

void KSycoca::addFactory

(

KSycocaFactory *

factory

)

Definition at line 320 of file ksycoca.cpp.

QStringList KSycoca::allResourceDirs

(

)

Definition at line 520 of file ksycoca.cpp.

void KSycoca::databaseChanged

(

)

[signal]

Connect to this to get notified when the database changes (Usually apps showing icons do a 'refresh' to take into account the new mimetypes).

void KSycoca::disableAutoRebuild

(

)

Definition at line 570 of file ksycoca.cpp.

KSycocaFactoryList * KSycoca::factories

(

)

[protected]

Definition at line 359 of file ksycoca.cpp.

QDataStream * KSycoca::findEntry	(	int	offset,
		KSycocaType &	type
	)

Definition at line 345 of file ksycoca.cpp.

QDataStream * KSycoca::findFactory

(

KSycocaFactoryId

id

)

Definition at line 437 of file ksycoca.cpp.

void KSycoca::flagError

(

)

[static]

A read error occurs.

Definition at line 547 of file ksycoca.cpp.

bool KSycoca::isAvailable

(

)

[static]

Returns:

true if the ksycoca database is available This is usually the case, except if KDE isn't installed yet, or before kded is started.

Definition at line 281 of file ksycoca.cpp.

bool KSycoca::isBuilding

(

)

[virtual]

Definition at line 565 of file ksycoca.cpp.

bool KSycoca::isChanged

(

const char *

type

)

[static]

When you receive a "databaseChanged" signal, you can query here if a change has occurred in a specific resource type.

See also:

KStandardDirs for the various resource types.

Definition at line 326 of file ksycoca.cpp.

QString KSycoca::kfsstnd_prefixes

(

)

Definition at line 462 of file ksycoca.cpp.

QString KSycoca::language

(

)

Definition at line 513 of file ksycoca.cpp.

bool KSycoca::readError

(

)

[static]

Returns read error status and clears flag.

Definition at line 575 of file ksycoca.cpp.

KSycoca * KSycoca::self

(

)

[static]

Get or create the only instance of KSycoca (read-only).

Definition at line 265 of file ksycoca.cpp.

quint32 KSycoca::timeStamp

(

)

Definition at line 487 of file ksycoca.cpp.

quint32 KSycoca::updateSignature

(

)

Definition at line 494 of file ksycoca.cpp.

int KSycoca::version

(

)

[static]

Returns:

the compiled-in version, i.e. the one used when writing a new ksycoca

Definition at line 129 of file ksycoca.cpp.

---

Member Data Documentation

QDataStream* KSycoca::m_str [protected]

Definition at line 199 of file ksycoca.h.

---

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

• ksycoca.h
• ksycoca.cpp