• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KSycoca Class Reference

#include <ksycoca.h>

Inheritance diagram for KSycoca:

Inheritance graph
[legend]

List of all members.


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

enum KSycoca::DatabaseType

type of database

See also:
absoluteFilePath()
Enumerator:
LocalDatabase 
GlobalDatabase 

Definition at line 59 of file ksycoca.h.


Constructor & Destructor Documentation

KSycoca::KSycoca ( bool   )  [explicit, protected]

For internal use only.

Building database

Definition at line 268 of file ksycoca.cpp.

KSycoca::KSycoca (  ) 

Read-only database.

Definition at line 147 of file ksycoca.cpp.

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  ) 

For internal use only.

- add a factory

Definition at line 333 of file ksycoca.cpp.

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]

A read error occurs.

Definition at line 560 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 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]

Returns read error status and clears flag.

Definition at line 588 of file ksycoca.cpp.

KSycoca * KSycoca::self (  )  [static]

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

Definition at line 277 of file ksycoca.cpp.

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]

Definition at line 188 of file ksycoca.h.


The documentation for this class was generated from the following files:
  • ksycoca.h
  • ksycoca.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal