KDevApi Class Reference
This abstract class provides an interface to KDevelop's core components. More...
#include <kdevapi.h>
Inheritance diagram for KDevApi:


Public Member Functions | |
KDevApi () | |
Constructor. | |
virtual | ~KDevApi () |
Destructor. | |
virtual KDevMainWindow * | mainWindow () const =0 |
Returns a reference to the main window. | |
virtual bool | mainWindowValid () const =0 |
Check if the main window is valid. | |
virtual KDevPartController * | partController () const =0 |
Returns a reference to the part controller component, which permits access to the current active parts (or components). | |
virtual KDevCore * | core () const =0 |
Returns a reference to core object which provides basic functionalities for inter-parts communications / cooperation. | |
virtual CodeModel * | codeModel () const =0 |
Returns a reference to encharged class store object. | |
virtual KDevDebugger * | debugger () const =0 |
Returns a reference to the debugger component. | |
QDomDocument * | projectDom () const |
Returns a reference to Document Object Model for the current project, or null if not project loaded. | |
void | setProjectDom (QDomDocument *dom) |
Set the Document Object Model for the current project. | |
KDevProject * | project () const |
Returns a reference to current project, or null if no project is loaded. | |
void | setProject (KDevProject *project) |
Set the current project. | |
KDevMakeFrontend * | makeFrontend () const |
Returns a reference to current make front-end, which runs build commands and display output messages in its widget; null if none is found. | |
void | setMakeFrontend (KDevMakeFrontend *makeFrontend) |
Set the make front-end to use. | |
KDevAppFrontend * | appFrontend () const |
Returns a reference to current application front-end, which runs displays running application's output messages in its widget; null if none is found. | |
void | setAppFrontend (KDevAppFrontend *appFrontend) |
Set the application front-end to use. | |
KDevLanguageSupport * | languageSupport () const |
Returns the module encharged for supporting the language(s) used in the project. | |
void | setLanguageSupport (KDevLanguageSupport *languageSupport) |
Set the object charged of providing handling for the source files. | |
KDevVersionControl * | versionControl () const |
Returns a reference to the version control used. | |
void | setVersionControl (KDevVersionControl *vcs) |
Set the default version control. | |
void | registerVersionControl (KDevVersionControl *vcs) |
Dinamically add a new Version Control plug-in to the IDE (several may be running in the same project). | |
void | unregisterVersionControl (KDevVersionControl *vcs) |
Dinamically deletes the version control plug-in from the list of the available ones. | |
QStringList | registeredVersionControls () const |
Returns a. | |
KDevVersionControl * | versionControlByName (const QString &uid) const |
Returns a reference to the version control identified by its id; will return null if the specified VCS is not present. | |
KDevDiffFrontend * | diffFrontend () const |
Returns the reference to the current diff frontend, which basically provides a way for pretty-displaying the output of the "diff" or "cvs diff" commands. | |
void | setDiffFrontend (KDevDiffFrontend *diffFrontend) |
Set the diff front-end to use (currently only one is provided). | |
KDevCreateFile * | createFile () const |
The kind of objects returned by this method provides widgets and methods for creating new files based on language features and user definable templates. | |
void | setCreateFile (KDevCreateFile *createFile) |
Set the object encharged for creating new files from templates. | |
KDevSourceFormatter * | sourceFormatter () const |
KDevSourceFormatter objects provides the ability to apply different standard formatting to the source or let the user to customize his own. | |
void | setSourceFormatter (KDevSourceFormatter *sourceFormatter) |
Set the Document Object Model for the current project. | |
KDevCodeRepository * | codeRepository () const |
KDevSourceRepository objects provides connections to the interested modules so they can know about what happens to code Catalogs. | |
Private Attributes | |
KDevApiPrivate * | d |
Detailed Description
This abstract class provides an interface to KDevelop's core components.
Definition at line 47 of file kdevapi.h.
Constructor & Destructor Documentation
|
Constructor.
Definition at line 64 of file kdevapi.cpp. References d, and KDevApiPrivate::m_codeRepository. |
|
Destructor.
Definition at line 72 of file kdevapi.cpp. References d, and KDevApiPrivate::m_codeRepository. |
Member Function Documentation
|
Returns a reference to current application front-end, which runs displays running application's output messages in its widget; null if none is found. Definition at line 108 of file kdevapi.cpp. References d, and KDevApiPrivate::m_appFrontend. Referenced by KDevPlugin::appFrontend(). |
|
Returns a reference to encharged class store object.
Implemented in API. Referenced by KDevPlugin::codeModel(). |
|
KDevSourceRepository objects provides connections to the interested modules so they can know about what happens to code Catalogs.
Definition at line 250 of file kdevapi.cpp. References d, and KDevApiPrivate::m_codeRepository. Referenced by KDevPlugin::codeRepository(). |
|
Returns a reference to core object which provides basic functionalities for inter-parts communications / cooperation.
Implemented in API. Referenced by KDevPlugin::core(). |
|
The kind of objects returned by this method provides widgets and methods for creating new files based on language features and user definable templates.
Definition at line 229 of file kdevapi.cpp. References d, and KDevApiPrivate::m_createFile. Referenced by KDevPlugin::createFileSupport(). |
|
Returns a reference to the debugger component.
Implemented in API. Referenced by KDevPlugin::debugger(). |
|
Returns the reference to the current diff frontend, which basically provides a way for pretty-displaying the output of the "diff" or "cvs diff" commands.
Definition at line 194 of file kdevapi.cpp. References d, and KDevApiPrivate::m_diffFrontend. Referenced by KDevPlugin::diffFrontend(). |
|
Returns the module encharged for supporting the language(s) used in the project.
Definition at line 122 of file kdevapi.cpp. References d, and KDevApiPrivate::m_languageSupport. Referenced by PartController::integratePart(), KDevPlugin::languageSupport(), and ProjectManager::unloadLanguageSupport(). |
|
Returns a reference to the main window.
Implemented in API. Referenced by KDevPlugin::mainWindow(). |
|
Check if the main window is valid.
Implemented in API. Referenced by KDevPlugin::mainWindowValid(). |
|
Returns a reference to current make front-end, which runs build commands and display output messages in its widget; null if none is found. Definition at line 94 of file kdevapi.cpp. References d, and KDevApiPrivate::m_makeFrontend. Referenced by KDevPlugin::makeFrontend(), and MainWindowShare::slotSettings(). |
|
Returns a reference to the part controller component, which permits access to the current active parts (or components).
Implemented in API. Referenced by KDevPlugin::partController(). |
|
Returns a reference to current project, or null if no project is loaded. Definition at line 80 of file kdevapi.cpp. References d, and KDevApiPrivate::m_project. Referenced by PartController::editDocumentInternal(), PartController::findOpenDocument(), PartController::findURLInProject(), KDevPlugin::project(), NewMainWindow::setCaption(), MainWindow::setCaption(), and ProjectManager::unloadProjectPart(). |
|
Returns a reference to Document Object Model for the current project, or null if not project loaded.
Definition at line 208 of file kdevapi.cpp. References d, and KDevApiPrivate::m_projectDom. Referenced by ProjectManager::loadProjectPart(), KDevPlugin::projectDom(), and ProjectManager::saveProjectFile(). |
|
Returns a.
Definition at line 166 of file kdevapi.cpp. References d, kdDebug(), KDevApiPrivate::m_registeredVcs, KDevVersionControl::uid(), and VersionControlMap. Referenced by KDevVersionControl::registeredVersionControls(). |
|
Dinamically add a new Version Control plug-in to the IDE (several may be running in the same project).
Definition at line 150 of file kdevapi.cpp. References d, KDevApiPrivate::m_registeredVcs, and KDevVersionControl::uid(). Referenced by KDevVersionControl::registerVersionControl(). |
|
Set the application front-end to use.
Definition at line 115 of file kdevapi.cpp. References d, and KDevApiPrivate::m_appFrontend. Referenced by PluginController::loadDefaultParts(). |
|
Set the object encharged for creating new files from templates.
Definition at line 222 of file kdevapi.cpp. References d, and KDevApiPrivate::m_createFile. Referenced by PluginController::loadDefaultParts(). |
|
Set the diff front-end to use (currently only one is provided).
Definition at line 201 of file kdevapi.cpp. References d, and KDevApiPrivate::m_diffFrontend. Referenced by PluginController::loadDefaultParts(). |
|
Set the object charged of providing handling for the source files.
Definition at line 129 of file kdevapi.cpp. References d, and KDevApiPrivate::m_languageSupport. Referenced by ProjectManager::loadLanguageSupport(), and ProjectManager::unloadLanguageSupport(). |
|
Set the make front-end to use.
Definition at line 101 of file kdevapi.cpp. References d, and KDevApiPrivate::m_makeFrontend. Referenced by PluginController::loadDefaultParts(). |
|
Set the current project.
Definition at line 87 of file kdevapi.cpp. References d, and KDevApiPrivate::m_project. Referenced by ProjectManager::loadProjectPart(), and ProjectManager::unloadProjectPart(). |
|
Set the Document Object Model for the current project.
Definition at line 215 of file kdevapi.cpp. References d, and KDevApiPrivate::m_projectDom. Referenced by ProjectManager::closeProject(), and ProjectManager::loadProjectFile(). |
|
Set the Document Object Model for the current project.
Definition at line 243 of file kdevapi.cpp. References d, and KDevApiPrivate::m_sourceFormatter. Referenced by PluginController::loadDefaultParts(). |
|
Set the default version control.
Definition at line 143 of file kdevapi.cpp. References d, and KDevApiPrivate::m_versionControl. Referenced by KDevVersionControl::setVersionControl(), and unregisterVersionControl(). |
|
KDevSourceFormatter objects provides the ability to apply different standard formatting to the source or let the user to customize his own.
Definition at line 236 of file kdevapi.cpp. References d, and KDevApiPrivate::m_sourceFormatter. Referenced by KDevPlugin::sourceFormatter(). |
|
Dinamically deletes the version control plug-in from the list of the available ones. The plug-in will be unloaded.
Definition at line 157 of file kdevapi.cpp. References d, KDevApiPrivate::m_registeredVcs, KDevApiPrivate::m_versionControl, setVersionControl(), and KDevVersionControl::uid(). Referenced by KDevVersionControl::unregisterVersionControl(). |
|
Returns a reference to the version control used.
Definition at line 136 of file kdevapi.cpp. References d, and KDevApiPrivate::m_versionControl. Referenced by KDevPlugin::versionControl(). |
|
Returns a reference to the version control identified by its id; will return null if the specified VCS is not present.
Definition at line 187 of file kdevapi.cpp. References d, and KDevApiPrivate::m_registeredVcs. Referenced by KDevVersionControl::versionControlByName(). |
Member Data Documentation
|
The documentation for this class was generated from the following files:
- lib/interfaces/kdevapi.h
- lib/interfaces/kdevapi.cpp