KDECore
KSycoca Class Reference
#include <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 |
Detailed Description
For internal use only.
Read-only SYstem COnfiguration CAche
Definition at line 42 of file ksycoca.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
KSycoca::KSycoca | ( | bool | ) | [explicit, protected] |
KSycoca::KSycoca | ( | ) |
KSycoca::~KSycoca | ( | ) | [virtual] |
Definition at line 286 of file ksycoca.cpp.
Member Function Documentation
QString KSycoca::absoluteFilePath | ( | DatabaseType | type = LocalDatabase |
) | [static] |
For internal use only.
- returns absolute file path of the database
for global database type the database is searched under the 'services' install path. Otherwise, the value from the environment variable KDESYCOCA is returned if set. If not set the path is build based on KStandardDirs cache save location.
Definition at line 514 of file ksycoca.cpp.
void KSycoca::addFactory | ( | KSycocaFactory * | factory | ) |
QStringList KSycoca::allResourceDirs | ( | ) |
For internal use only.
- returns all directories with information stored inside sycoca.
Definition at line 533 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 | ( | ) |
For internal use only.
- disables launching of kbuildsycoca
Definition at line 583 of file ksycoca.cpp.
KSycocaFactoryList * KSycoca::factories | ( | ) | [protected] |
Definition at line 372 of file ksycoca.cpp.
QDataStream * KSycoca::findEntry | ( | int | offset, | |
KSycocaType & | type | |||
) |
For internal use only.
- called by factories in read-only mode This is how factories get a stream to an entry
Definition at line 358 of file ksycoca.cpp.
QDataStream * KSycoca::findFactory | ( | KSycocaFactoryId | id | ) |
For internal use only.
- called by factories in read-only mode
Definition at line 450 of file ksycoca.cpp.
void KSycoca::flagError | ( | ) | [static] |
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 293 of file ksycoca.cpp.
bool KSycoca::isBuilding | ( | ) | [virtual] |
For internal use only.
- Returns:
- true if building (i.e. if a KBuildSycoca);
Definition at line 578 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 339 of file ksycoca.cpp.
QString KSycoca::kfsstnd_prefixes | ( | ) |
For internal use only.
- returns kfsstnd stored inside database
Definition at line 475 of file ksycoca.cpp.
QString KSycoca::language | ( | ) |
For internal use only.
- returns language stored inside database
Definition at line 526 of file ksycoca.cpp.
bool KSycoca::readError | ( | ) | [static] |
KSycoca * KSycoca::self | ( | ) | [static] |
quint32 KSycoca::timeStamp | ( | ) |
For internal use only.
- returns timestamp of database
The database contains all changes made _before_ this time and _might_ contain changes made after that.
Definition at line 500 of file ksycoca.cpp.
quint32 KSycoca::updateSignature | ( | ) |
For internal use only.
- returns update signature of database
Signature that keeps track of changes to $KDEDIR/share/services/update_ksycoca
Touching this file causes the database to be recreated from scratch.
Definition at line 507 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 141 of file ksycoca.cpp.
Member Data Documentation
QDataStream* KSycoca::m_str [protected] |
The documentation for this class was generated from the following files: