#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.
Constructor & Destructor Documentation
◆ KDevApi()
KDevApi::KDevApi | ( | ) |
Constructor.
Definition at line 46 of file kdevapi.cpp.
◆ ~KDevApi()
|
virtual |
Destructor.
Definition at line 52 of file kdevapi.cpp.
Member Function Documentation
◆ codeModel()
|
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()
|
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()
|
pure virtual |
- Returns
- A reference to the toplevel widget.
◆ partController()
|
pure virtual |
- Returns
- A reference to the part controller which is used to manipulate loaded KParts.
◆ pluginController()
|
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
-
languageSupport The language support plugin.
Definition at line 73 of file kdevapi.cpp.
◆ setProject()
void KDevApi::setProject | ( | KDevProject * | project | ) |
Sets the current project.
- Parameters
-
project The 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
-
dom The project DOM.
Definition at line 83 of file kdevapi.cpp.
The documentation for this class was generated from the following files: