Catalog Class Reference

#include <catalog.h>

Public Types
typedef TQPair< TQCString, TQVariant >	QueryArgument

Public Member Functions
bool	isValid () const
TQString	dbName () const
bool	enabled () const
void	setEnabled (bool en)
virtual void	open (const TQString &dbName)
virtual void	close ()
virtual void	sync ()
TQValueList< TQCString >	indexList () const
void	addIndex (const TQCString &name)
void	addItem (Tag &tag)
Tag	getItemById (const TQCString &id)
TQValueList< Tag >	query (const TQValueList< QueryArgument > &args)
TQCString	generateId ()

Detailed Description

Catalog objects represent separate symbol databases.

Catalogs can be created/loaded/unloaded dynamically. To find a symbol in the repository each catalog should be queried.

Persistent symbol store is useful to keep information about code that never or rarely changes. System libraries are perfect examples of such code.

Definition at line 42 of file catalog.h.

Member Typedef Documentation

QueryArgument

typedef TQPair<TQCString, TQVariant> Catalog::QueryArgument

Definition at line 45 of file catalog.h.

Constructor & Destructor Documentation

Catalog()

Catalog::Catalog

(

)

Definition at line 131 of file catalog.cpp.

~Catalog()

Catalog::~Catalog ( )

virtual

Definition at line 139 of file catalog.cpp.

Member Function Documentation

addIndex()

void Catalog::addIndex

(

const TQCString &

name

)

Todo:

document these functions

Definition at line 175 of file catalog.cpp.

addItem()

void Catalog::addItem

(

Tag &

tag

)

Definition at line 294 of file catalog.cpp.

close()

void Catalog::close ( )

virtual

Definition at line 218 of file catalog.cpp.

dbName()

TQString Catalog::dbName

(

)

const

Definition at line 276 of file catalog.cpp.

enabled()

bool Catalog::enabled

(

)

const

Definition at line 161 of file catalog.cpp.

generateId()

TQCString Catalog::generateId

(

)

Definition at line 459 of file catalog.cpp.

getItemById()

Tag Catalog::getItemById

(

const TQCString &

id

)

Definition at line 316 of file catalog.cpp.

indexList()

TQValueList< TQCString > Catalog::indexList

(

)

const

Definition at line 149 of file catalog.cpp.

isValid()

bool Catalog::isValid

(

)

const

Definition at line 285 of file catalog.cpp.

open()

void Catalog::open ( const TQString &  dbName )

virtual

Definition at line 241 of file catalog.cpp.

query()

TQValueList< Tag > Catalog::query

(

const TQValueList< QueryArgument > &

args

)

Definition at line 368 of file catalog.cpp.

setEnabled()

void Catalog::setEnabled

(

bool

en

)

Definition at line 166 of file catalog.cpp.

sync()

void Catalog::sync ( )

virtual

Definition at line 352 of file catalog.cpp.

---

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

• catalog.h
• catalog.cpp