KDevelop API Documentation

API Class Reference

#include <api.h>

Inheritance diagram for API:

KDevApi QObject List of all members.

Public Member Functions

virtual KDevMainWindowmainWindow () const
 Returns a reference to the main window.

virtual bool mainWindowValid () const
 Check if the main window is valid.

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

virtual KDevCorecore () const
 Returns a reference to core object which provides basic functionalities for inter-parts communications / cooperation.

virtual CodeModelcodeModel () const
 Returns a reference to encharged class store object.

virtual KDevDebuggerdebugger () const
 Returns a reference to the debugger component.

 ~API ()

Static Public Member Functions

APIgetInstance ()

Protected Member Functions

 API ()

Private Attributes

CodeModelm_classStore

Static Private Attributes

APIs_instance = 0

Constructor & Destructor Documentation

API::~API  ) 
 

Definition at line 61 of file api.cpp.

References m_classStore.

API::API  )  [protected]
 

Definition at line 54 of file api.cpp.

References m_classStore.


Member Function Documentation

CodeModel * API::codeModel  )  const [virtual]
 

Returns a reference to encharged class store object.

Implements KDevApi.

Definition at line 34 of file api.cpp.

References m_classStore.

Referenced by ProjectManager::closeProject().

KDevCore * API::core  )  const [virtual]
 

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

Implements KDevApi.

Definition at line 28 of file api.cpp.

References Core::getInstance().

KDevDebugger * API::debugger  )  const [virtual]
 

Returns a reference to the debugger component.

Implements KDevApi.

Definition at line 40 of file api.cpp.

References Debugger::getInstance().

API * API::getInstance  )  [static]
 

Definition at line 46 of file api.cpp.

References s_instance.

Referenced by ProjectManager::closeProject(), MainWindowShare::createActions(), PartController::editDocument(), PartController::findOpenDocument(), PartController::findURLInProject(), ProjectManager::loadCreateFileSupport(), loadDefaultPart(), PluginController::loadDefaultParts(), ProjectManager::loadLanguageSupport(), PluginController::loadPlugin(), ProjectManager::loadProjectFile(), ProjectManager::loadProjectPart(), MainWindow::raiseEditor(), ProjectSession::recreateDocs(), ProjectManager::saveProjectFile(), MainWindow::setCaption(), MainWindowShare::slotConfigureEditors(), MainWindowShare::slotSettings(), ProjectManager::unloadCreateFileSupport(), ProjectManager::unloadLanguageSupport(), and ProjectManager::unloadProjectPart().

KDevMainWindow * API::mainWindow  )  const [virtual]
 

Returns a reference to the main window.

See also:
KDevMainWindow

Implements KDevApi.

Definition at line 12 of file api.cpp.

References TopLevel::getInstance().

Referenced by ProjectSession::recreateDocs().

bool API::mainWindowValid  )  const [virtual]
 

Check if the main window is valid.

Implements KDevApi.

Definition at line 17 of file api.cpp.

References TopLevel::mainWindowValid().

KDevPartController * API::partController  )  const [virtual]
 

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

See also:
KDevPartController

Implements KDevApi.

Definition at line 22 of file api.cpp.

References PartController::getInstance().

Referenced by MainWindowShare::createActions(), MainWindow::raiseEditor(), and MainWindowShare::slotConfigureEditors().


Member Data Documentation

CodeModel* API::m_classStore [private]
 

Definition at line 37 of file api.h.

Referenced by API(), codeModel(), and ~API().

API * API::s_instance = 0 [static, private]
 

Definition at line 9 of file api.cpp.

Referenced by getInstance().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.0.4.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Oct 6 17:39:19 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003