KDevelop API Documentation

KDevApi Class Reference

This abstract class provides an interface to KDevelop's core components. More...

#include <kdevapi.h>

Inheritance diagram for KDevApi:

Inheritance graph
[legend]
Collaboration diagram for KDevApi:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 KDevApi ()
 Constructor.
virtual ~KDevApi ()
 Destructor.
virtual KDevMainWindowmainWindow () const =0
 Returns a reference to the main window.
virtual bool mainWindowValid () const =0
 Check if the main window is valid.
virtual KDevPartControllerpartController () const =0
 Returns a reference to the part controller component, which permits access to the current active parts (or components).
virtual KDevCorecore () const =0
 Returns a reference to core object which provides basic functionalities for inter-parts communications / cooperation.
virtual CodeModelcodeModel () const =0
 Returns a reference to encharged class store object.
virtual KDevDebuggerdebugger () const =0
 Returns a reference to the debugger component.
QDomDocumentprojectDom () 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.
KDevProjectproject () const
 Returns a reference to current project, or null if no project is loaded.
void setProject (KDevProject *project)
 Set the current project.
KDevMakeFrontendmakeFrontend () 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.
KDevAppFrontendappFrontend () 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.
KDevLanguageSupportlanguageSupport () 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.
KDevVersionControlversionControl () 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.
KDevVersionControlversionControlByName (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.
KDevDiffFrontenddiffFrontend () 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).
KDevCreateFilecreateFile () 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.
KDevSourceFormattersourceFormatter () 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.
KDevCodeRepositorycodeRepository () const
 KDevSourceRepository objects provides connections to the interested modules so they can know about what happens to code Catalogs.

Private Attributes

KDevApiPrivated

Detailed Description

This abstract class provides an interface to KDevelop's core components.

Definition at line 47 of file kdevapi.h.


Constructor & Destructor Documentation

KDevApi::KDevApi  ) 
 

Constructor.

Definition at line 64 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_codeRepository.

KDevApi::~KDevApi  )  [virtual]
 

Destructor.

Definition at line 72 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_codeRepository.


Member Function Documentation

KDevAppFrontend * KDevApi::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.

KDevMakeFrontend

Definition at line 108 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_appFrontend.

Referenced by KDevPlugin::appFrontend().

virtual CodeModel* KDevApi::codeModel  )  const [pure virtual]
 

Returns a reference to encharged class store object.

Implemented in API.

Referenced by KDevPlugin::codeModel().

KDevCodeRepository * KDevApi::codeRepository  )  const
 

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().

virtual KDevCore* KDevApi::core  )  const [pure virtual]
 

Returns a reference to core object which provides basic functionalities for inter-parts communications / cooperation.

Implemented in API.

Referenced by KDevPlugin::core().

KDevCreateFile * KDevApi::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.

See also:
KDevCreateFile

Definition at line 229 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_createFile.

Referenced by KDevPlugin::createFileSupport().

virtual KDevDebugger* KDevApi::debugger  )  const [pure virtual]
 

Returns a reference to the debugger component.

Implemented in API.

Referenced by KDevPlugin::debugger().

KDevDiffFrontend * KDevApi::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.

See also:
KDevDiffFrontend

Definition at line 194 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_diffFrontend.

Referenced by KDevPlugin::diffFrontend().

KDevLanguageSupport * KDevApi::languageSupport  )  const
 

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().

virtual KDevMainWindow* KDevApi::mainWindow  )  const [pure virtual]
 

Returns a reference to the main window.

See also:
KDevMainWindow

Implemented in API.

Referenced by KDevPlugin::mainWindow().

virtual bool KDevApi::mainWindowValid  )  const [pure virtual]
 

Check if the main window is valid.

Implemented in API.

Referenced by KDevPlugin::mainWindowValid().

KDevMakeFrontend * KDevApi::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.

KDevMakeFrontend

Definition at line 94 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_makeFrontend.

Referenced by KDevPlugin::makeFrontend(), and MainWindowShare::slotSettings().

virtual KDevPartController* KDevApi::partController  )  const [pure virtual]
 

Returns a reference to the part controller component, which permits access to the current active parts (or components).

See also:
KDevPartController

Implemented in API.

Referenced by KDevPlugin::partController().

KDevProject * KDevApi::project  )  const
 

Returns a reference to current project, or null if no project is loaded.

KDevProject

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().

QDomDocument * KDevApi::projectDom  )  const
 

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().

QStringList KDevApi::registeredVersionControls  )  const
 

Returns a.

See also:
QStringList containing unique (among the list) identifiers of the registered version control systems (currently their names).

Definition at line 166 of file kdevapi.cpp.

References d, kdDebug(), KDevApiPrivate::m_registeredVcs, KDevVersionControl::uid(), and VersionControlMap.

Referenced by KDevVersionControl::registeredVersionControls().

void KDevApi::registerVersionControl KDevVersionControl vcs  ) 
 

Dinamically add a new Version Control plug-in to the IDE (several may be running in the same project).

Parameters:
vcs new version control object

Definition at line 150 of file kdevapi.cpp.

References d, KDevApiPrivate::m_registeredVcs, and KDevVersionControl::uid().

Referenced by KDevVersionControl::registerVersionControl().

void KDevApi::setAppFrontend KDevAppFrontend appFrontend  ) 
 

Set the application front-end to use.

Parameters:
appFrontend 

Definition at line 115 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_appFrontend.

Referenced by PluginController::loadDefaultParts().

void KDevApi::setCreateFile KDevCreateFile createFile  ) 
 

Set the object encharged for creating new files from templates.

Parameters:
createFile 

Definition at line 222 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_createFile.

Referenced by PluginController::loadDefaultParts().

void KDevApi::setDiffFrontend KDevDiffFrontend diffFrontend  ) 
 

Set the diff front-end to use (currently only one is provided).

Parameters:
diffFrontend 

Definition at line 201 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_diffFrontend.

Referenced by PluginController::loadDefaultParts().

void KDevApi::setLanguageSupport KDevLanguageSupport languageSupport  ) 
 

Set the object charged of providing handling for the source files.

Parameters:
languageSupport 

Definition at line 129 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_languageSupport.

Referenced by ProjectManager::loadLanguageSupport(), and ProjectManager::unloadLanguageSupport().

void KDevApi::setMakeFrontend KDevMakeFrontend makeFrontend  ) 
 

Set the make front-end to use.

Parameters:
makeFrontend 

Definition at line 101 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_makeFrontend.

Referenced by PluginController::loadDefaultParts().

void KDevApi::setProject KDevProject project  ) 
 

Set the current project.

Parameters:
project 

Definition at line 87 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_project.

Referenced by ProjectManager::loadProjectPart(), and ProjectManager::unloadProjectPart().

void KDevApi::setProjectDom QDomDocument dom  ) 
 

Set the Document Object Model for the current project.

Parameters:
dom 

Definition at line 215 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_projectDom.

Referenced by ProjectManager::closeProject(), and ProjectManager::loadProjectFile().

void KDevApi::setSourceFormatter KDevSourceFormatter sourceFormatter  ) 
 

Set the Document Object Model for the current project.

Parameters:
sourceFormatter 

Definition at line 243 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_sourceFormatter.

Referenced by PluginController::loadDefaultParts().

void KDevApi::setVersionControl KDevVersionControl vcs  ) 
 

Set the default version control.

Parameters:
vcs 

Definition at line 143 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_versionControl.

Referenced by KDevVersionControl::setVersionControl(), and unregisterVersionControl().

KDevSourceFormatter * KDevApi::sourceFormatter  )  const
 

KDevSourceFormatter objects provides the ability to apply different standard formatting to the source or let the user to customize his own.

See also:
KDevSourceFormatter

Definition at line 236 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_sourceFormatter.

Referenced by KDevPlugin::sourceFormatter().

void KDevApi::unregisterVersionControl KDevVersionControl vcs  ) 
 

Dinamically deletes the version control plug-in from the list of the available ones.

The plug-in will be unloaded.

Parameters:
vcs version control object to delete

Definition at line 157 of file kdevapi.cpp.

References d, KDevApiPrivate::m_registeredVcs, KDevApiPrivate::m_versionControl, setVersionControl(), and KDevVersionControl::uid().

Referenced by KDevVersionControl::unregisterVersionControl().

KDevVersionControl * KDevApi::versionControl  )  const
 

Returns a reference to the version control used.

Returns:

Definition at line 136 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_versionControl.

Referenced by KDevPlugin::versionControl().

KDevVersionControl * KDevApi::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.

Parameters:
uid unique identifier of the VCS to unload, as returned by
See also:
KDevVersionControl::uid().

Definition at line 187 of file kdevapi.cpp.

References d, and KDevApiPrivate::m_registeredVcs.

Referenced by KDevVersionControl::versionControlByName().


Member Data Documentation

KDevApiPrivate* KDevApi::d [private]
 

Definition at line 232 of file kdevapi.h.

Referenced by appFrontend(), codeRepository(), createFile(), diffFrontend(), KDevApi(), languageSupport(), makeFrontend(), project(), projectDom(), registeredVersionControls(), registerVersionControl(), setAppFrontend(), setCreateFile(), setDiffFrontend(), setLanguageSupport(), setMakeFrontend(), setProject(), setProjectDom(), setSourceFormatter(), setVersionControl(), sourceFormatter(), unregisterVersionControl(), versionControl(), versionControlByName(), and ~KDevApi().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 00:22:09 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003