• Skip to content
  • Skip to link menu
KDE 4.1 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.


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

KSycoca::KSycoca (  ) 

Read-only database.

Definition at line 134 of file ksycoca.cpp.

KSycoca::~KSycoca (  )  [virtual]

Definition at line 273 of file ksycoca.cpp.


Member Function Documentation

QString KSycoca::absoluteFilePath ( DatabaseType  type = LocalDatabase  )  [static]

Definition at line 500 of file ksycoca.cpp.

void KSycoca::addFactory ( KSycocaFactory *  factory  ) 

Definition at line 319 of file ksycoca.cpp.

QStringList KSycoca::allResourceDirs (  ) 

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

KSycocaFactoryList * KSycoca::factories (  )  [protected]

Definition at line 358 of file ksycoca.cpp.

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

Definition at line 344 of file ksycoca.cpp.

QDataStream * KSycoca::findFactory ( KSycocaFactoryId  id  ) 

Definition at line 436 of file ksycoca.cpp.

void KSycoca::flagError (  )  [static]

A read error occurs.

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

bool KSycoca::isBuilding (  )  [virtual]

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

QString KSycoca::kfsstnd_prefixes (  ) 

Definition at line 461 of file ksycoca.cpp.

QString KSycoca::language (  ) 

Definition at line 512 of file ksycoca.cpp.

bool KSycoca::readError (  )  [static]

Returns read error status and clears flag.

Definition at line 574 of file ksycoca.cpp.

KSycoca * KSycoca::self (  )  [static]

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

Definition at line 264 of file ksycoca.cpp.

quint32 KSycoca::timeStamp (  ) 

Definition at line 486 of file ksycoca.cpp.

quint32 KSycoca::updateSignature (  ) 

Definition at line 493 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 128 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

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
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
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