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

KDECore

KSycoca Class Reference

#include <ksycoca.h>

Inheritance diagram for KSycoca:

Inheritance graph
[legend]

List of all members.


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 ()
Q_UINT32 timeStamp ()
Q_UINT32 updateSignature ()
virtual ~KSycoca ()

Static Public Member Functions

static QString determineRelativePath (const QString &_fullpath, const char *_resource)
static void flagError ()
static bool isChanged (const char *type)
static bool readError ()
static KSycoca * self ()
static int version ()

Static Public Attributes

static KSycoca * _self = 0L

Protected Member Functions

bool checkVersion (bool abortOnError=true)
void closeDatabase ()
 KSycoca (bool)
bool openDatabase (bool openDummyIfNotFound=true)
virtual void virtual_hook (int id, void *data)

Protected Attributes

bool bNoDatabase
KSycocaFactoryList * m_lstFactories
QDataStream * m_str
const char * m_sycoca_mmap
size_t m_sycoca_size
Q_UINT32 m_timeStamp

Detailed Description

For internal use only.

Read-only SYstem COnfiguration CAche

Definition at line 44 of file ksycoca.h.


Constructor & Destructor Documentation

KSycoca::KSycoca ( bool   )  [protected]

For internal use only.

Building database

Definition at line 197 of file ksycoca.cpp.

KSycoca::KSycoca (  ) 

Read-only database.

Definition at line 89 of file ksycoca.cpp.

KSycoca::~KSycoca (  )  [virtual]

Definition at line 220 of file ksycoca.cpp.


Member Function Documentation

void KSycoca::addFactory ( KSycocaFactory *  factory  ) 

For internal use only.

- add a factory

Definition at line 257 of file ksycoca.cpp.

QStringList KSycoca::allResourceDirs (  ) 

For internal use only.

- returns all directories with information stored inside sycoca.

Definition at line 413 of file ksycoca.cpp.

bool KSycoca::checkVersion ( bool  abortOnError = true  )  [protected]

Definition at line 295 of file ksycoca.cpp.

void KSycoca::closeDatabase (  )  [protected]

Definition at line 227 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).

QString KSycoca::determineRelativePath ( const QString &  _fullpath,
const char *  _resource 
) [static]

Determine relative path for a .desktop file from a full path and a resource name.

Definition at line 420 of file ksycoca.cpp.

void KSycoca::disableAutoRebuild (  ) 

For internal use only.

- disables launching of kbuildsycoca

Definition at line 454 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 282 of file ksycoca.cpp.

QDataStream * KSycoca::findFactory ( KSycocaFactoryId  id  ) 

For internal use only.

- called by factories in read-only mode

Definition at line 318 of file ksycoca.cpp.

void KSycoca::flagError (  )  [static]

A read error occurs.

Definition at line 440 of file ksycoca.cpp.

virtual bool KSycoca::isBuilding (  )  [inline, virtual]

For internal use only.

Returns:
true if building (i.e. if a KBuildSycoca);

Definition at line 124 of file ksycoca.h.

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 263 of file ksycoca.cpp.

QString KSycoca::kfsstnd_prefixes (  ) 

For internal use only.

- returns kfsstnd stored inside database

Definition at line 367 of file ksycoca.cpp.

QString KSycoca::language (  ) 

For internal use only.

- returns language stored inside database

Definition at line 406 of file ksycoca.cpp.

void KSycoca::notifyDatabaseChanged ( const QStringList &  changeList  ) 

internal function for receiving kded/kbuildsycoca's signal, when the sycoca file changes

Definition at line 268 of file ksycoca.cpp.

bool KSycoca::openDatabase ( bool  openDummyIfNotFound = true  )  [protected]

Definition at line 107 of file ksycoca.cpp.

bool KSycoca::readError (  )  [static]

Returns read error status and clears flag.

Definition at line 459 of file ksycoca.cpp.

KSycoca * KSycoca::self (  )  [static]

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

Definition at line 211 of file ksycoca.cpp.

Q_UINT32 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 392 of file ksycoca.cpp.

Q_UINT32 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 399 of file ksycoca.cpp.

int KSycoca::version (  )  [static]

Definition at line 83 of file ksycoca.cpp.

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

Definition at line 518 of file ksycoca.cpp.


Member Data Documentation

KSycoca * KSycoca::_self = 0L [static]

Definition at line 178 of file ksycoca.h.

bool KSycoca::bNoDatabase [protected]

Definition at line 172 of file ksycoca.h.

KSycocaFactoryList* KSycoca::m_lstFactories [protected]

Definition at line 170 of file ksycoca.h.

QDataStream* KSycoca::m_str [protected]

Definition at line 171 of file ksycoca.h.

const char* KSycoca::m_sycoca_mmap [protected]

Definition at line 174 of file ksycoca.h.

size_t KSycoca::m_sycoca_size [protected]

Definition at line 173 of file ksycoca.h.

Q_UINT32 KSycoca::m_timeStamp [protected]

Definition at line 175 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

API Reference

Skip menu "API Reference"
  • dcop
  • DNSSD
  • interfaces
  • Kate
  • kconf_update
  • KDECore
  • KDED
  • kdefx
  • KDEsu
  • kdeui
  • KDocTools
  • KHTML
  • KImgIO
  • KInit
  • kio
  • kioslave
  • KJS
  • KNewStuff
  • KParts
  • KUtils
Generated for API Reference by doxygen 1.5.9
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