• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • TDevelop Interfaces Library
 

TDevelop Interfaces Library

Signals | Public Member Functions | List of all members
KDevCodeRepository Class Reference

#include <kdevcoderepository.h>

Inherits TQObject.

Signals

void catalogRegistered (Catalog *catalog)
 
void catalogUnregistered (Catalog *catalog)
 
void catalogChanged (Catalog *catalog)
 

Public Member Functions

 KDevCodeRepository ()
 
virtual ~KDevCodeRepository ()
 
Catalog * mainCatalog ()
 
void setMainCatalog (Catalog *mainCatalog)
 
TQValueList< Catalog * > registeredCatalogs ()
 
void registerCatalog (Catalog *catalog)
 
void unregisterCatalog (Catalog *catalog)
 
void touchCatalog (Catalog *catalog)
 

Detailed Description

Code repository - the persistent symbol store accessor.

Symbols from parsed files can be saved to the persistent symbol store. Persistence in this case means that symbol database is never loaded into memory and works like a usual database which executes queries.

Code repository consists from Catalog objects that 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. Symbols from code contained in project files are better stored in memory symbol store like CodeModel.

Definition at line 48 of file kdevcoderepository.h.

Constructor & Destructor Documentation

◆ KDevCodeRepository()

KDevCodeRepository::KDevCodeRepository ( )

Constructor.

Definition at line 29 of file kdevcoderepository.cpp.

◆ ~KDevCodeRepository()

KDevCodeRepository::~KDevCodeRepository ( )
virtual

Destructor.

Definition at line 34 of file kdevcoderepository.cpp.

Member Function Documentation

◆ catalogChanged

void KDevCodeRepository::catalogChanged ( Catalog *  catalog)
signal

Emitted when the contens of catalog is changed.

Parameters
catalogChanged catalog.

◆ catalogRegistered

void KDevCodeRepository::catalogRegistered ( Catalog *  catalog)
signal

Emitted when a new catalog is registered.

Parameters
catalogThe new catalog.

◆ catalogUnregistered

void KDevCodeRepository::catalogUnregistered ( Catalog *  catalog)
signal

Emitted when a catalog in removed.

Parameters
catalogThe catalog that was removed.

◆ mainCatalog()

Catalog * KDevCodeRepository::mainCatalog ( )
Returns
The main catalog. Each catalog can be marked is main to provide easy access to it.

Definition at line 39 of file kdevcoderepository.cpp.

◆ registerCatalog()

void KDevCodeRepository::registerCatalog ( Catalog *  catalog)

Registers catalog in the repository.

Parameters
catalogThe catalog to register.

Definition at line 49 of file kdevcoderepository.cpp.

◆ registeredCatalogs()

TQValueList< Catalog *> KDevCodeRepository::registeredCatalogs ( )
Returns
The list of registered catalogs.

Definition at line 66 of file kdevcoderepository.cpp.

◆ setMainCatalog()

void KDevCodeRepository::setMainCatalog ( Catalog *  mainCatalog)

Sets the main catalog.

Parameters
mainCatalogThe catalog to be marked as main.

Definition at line 44 of file kdevcoderepository.cpp.

◆ touchCatalog()

void KDevCodeRepository::touchCatalog ( Catalog *  catalog)

Marks catalog as changed and emits catalogChanged signal.

Parameters
catalogThe catalog to touch.

Definition at line 61 of file kdevcoderepository.cpp.

◆ unregisterCatalog()

void KDevCodeRepository::unregisterCatalog ( Catalog *  catalog)

Unregisters catalog from the repository.

Parameters
catalogThe catalog to unregister.

Definition at line 55 of file kdevcoderepository.cpp.


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

TDevelop Interfaces Library

Skip menu "TDevelop Interfaces Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

TDevelop Interfaces Library

Skip menu "TDevelop Interfaces Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for TDevelop Interfaces Library by doxygen 1.8.13
This website is maintained by Timothy Pearson.