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

TDevelop Interfaces Library

Public Member Functions | List of all members
KDevApi Class Referenceabstract

#include <kdevapi.h>

Inherits TQObject.

Public Member Functions

 KDevApi ()
 
virtual ~KDevApi ()
 
virtual KDevMainWindow * mainWindow () const =0
 
virtual KDevPartController * partController () const =0
 
virtual KDevPluginController * pluginController () const =0
 
virtual KDevCore * core () const =0
 
virtual CodeModel * codeModel () const =0
 
TQDomDocument * projectDom () const
 
void setProjectDom (TQDomDocument *dom)
 
KDevProject * project () const
 
void setProject (KDevProject *project)
 
KDevLanguageSupport * languageSupport () const
 
void setLanguageSupport (KDevLanguageSupport *languageSupport)
 
KDevCodeRepository * codeRepository () const
 

Detailed Description

The interface to KDevelop's core components.

Needs to be implemented in a shell. Developers do not need to use this class because KDevPlugin already provides API convenience methods.

Definition at line 47 of file kdevapi.h.

Constructor & Destructor Documentation

◆ KDevApi()

KDevApi::KDevApi ( )

Constructor.

Definition at line 46 of file kdevapi.cpp.

◆ ~KDevApi()

KDevApi::~KDevApi ( )
virtual

Destructor.

Definition at line 52 of file kdevapi.cpp.

Member Function Documentation

◆ codeModel()

virtual CodeModel* KDevApi::codeModel ( ) const
pure virtual
Returns
A reference to the memory symbol store.

◆ codeRepository()

KDevCodeRepository * KDevApi::codeRepository ( ) const
Returns
A reference to the code repository (accessor to persistent symbol stores).

Definition at line 88 of file kdevapi.cpp.

◆ core()

virtual KDevCore* KDevApi::core ( ) const
pure virtual
Returns
A reference to the application core - an object which provides basic functionalities for inter-parts communications / cooperation.

◆ languageSupport()

KDevLanguageSupport * KDevApi::languageSupport ( ) const
Returns
A reference to the language support component or 0 if no support available.

Definition at line 68 of file kdevapi.cpp.

◆ mainWindow()

virtual KDevMainWindow* KDevApi::mainWindow ( ) const
pure virtual
Returns
A reference to the toplevel widget.

◆ partController()

virtual KDevPartController* KDevApi::partController ( ) const
pure virtual
Returns
A reference to the part controller which is used to manipulate loaded KParts.

◆ pluginController()

virtual KDevPluginController* KDevApi::pluginController ( ) const
pure virtual
Returns
A reference to the plugin controller which is used to manipulate loaded plugin.

◆ project()

KDevProject * KDevApi::project ( ) const
Returns
A reference to the current project component or 0 if no project is loaded.

Definition at line 58 of file kdevapi.cpp.

◆ projectDom()

TQDomDocument * KDevApi::projectDom ( ) const
Returns
A reference to the DOM tree that represents the project file or 0 if no project is loaded.

Definition at line 78 of file kdevapi.cpp.

◆ setLanguageSupport()

void KDevApi::setLanguageSupport ( KDevLanguageSupport *  languageSupport)

Sets the object charged of providing handling for the source files written in particular language (languages support component).

Parameters
languageSupportThe language support plugin.

Definition at line 73 of file kdevapi.cpp.

◆ setProject()

void KDevApi::setProject ( KDevProject *  project)

Sets the current project.

Parameters
projectThe project plugin which becames the current project.

Definition at line 63 of file kdevapi.cpp.

◆ setProjectDom()

void KDevApi::setProjectDom ( TQDomDocument *  dom)

Sets the Document Object Model for the current project.

Parameters
domThe project DOM.

Definition at line 83 of file kdevapi.cpp.


The documentation for this class was generated from the following files:
  • kdevapi.h
  • kdevapi.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.