KDevPlugin Class Reference
This is the base class for all components like doc tree view, LFV, RFV and so on. More...
#include <kdevplugin.h>
Inheritance diagram for KDevPlugin:

Signals | |
void | aboutToShowPart () |
Emitted when the part will be shown. | |
Public Member Functions | |
KDevPlugin (const QString &pluginName, const QString &icon, QObject *parent, const char *name=0) | |
Constructs a component. | |
~KDevPlugin () | |
Destructs a component. | |
QString | pluginName () const |
Offers access to KDevelop core. | |
QString | icon () const |
Returns the name of the icon. | |
virtual QString | shortDescription () const |
Returns the short description. | |
virtual QString | description () const |
Returns the description. | |
virtual bool | createDCOPInterface (const QString &) |
Create the DCOP interface for the given serviceType , if this plugin provides it. | |
virtual QStringList | configModules () const |
Reimplement this method and return a QStringList of all config modules your application part should offer via KDevelop. | |
virtual KAboutData * | aboutData () |
Reimplement this method if you want to add your credits to the KDevelop about dialog. | |
virtual KParts::Part * | part () |
reimplement and retun the part here.You can use this method if you need to access the current part. | |
DCOPClient * | dcopClient () const |
Retrieve the current DCOP Client for the plugin. | |
virtual QWidget * | widget () |
Returns the widget of the plugin. | |
KDevMainWindow * | mainWindow () |
Gives a reference to the toplevel widget. | |
bool | mainWindowValid () |
Indicates whether a valid main window is active. | |
KDevCore * | core () const |
Gives a reference to the application core. | |
KDevProject * | project () const |
Gives a reference to the current project component. | |
KDevLanguageSupport * | languageSupport () const |
Gives a reference to the language support component. | |
KDevMakeFrontend * | makeFrontend () const |
Gives a reference to the make frontend component. | |
KDevDiffFrontend * | diffFrontend () const |
Gives a reference to the diff frontend component. | |
KDevAppFrontend * | appFrontend () const |
Gives a reference to the application frontend component. | |
CodeModel * | codeModel () const |
Gives a reference to the class store. | |
QDomDocument * | projectDom () const |
Gives a reference to the DOM tree that represents the project file. | |
KDevPartController * | partController () const |
Returns a reference to the part controller. | |
KDevDebugger * | debugger () const |
Returns a reference to the debugger API. | |
KDevCreateFile * | createFileSupport () const |
Returns a reference to the Create File API. | |
KDevSourceFormatter * | sourceFormatter () const |
Returns a reference to the source formatter. | |
virtual void | restorePartialProjectSession (const QDomElement *el) |
To restore any settings which differs from project to project, you can override this base class method to read in from a certain subtree of the project session file. | |
virtual void | savePartialProjectSession (QDomElement *el) |
void | registerVersionControl (KDevVersionControl *vcs) |
Add vcs to the list of the registered VCS. | |
KDevVersionControl * | versionControl () const |
Add to the list of the registered VCS. | |
void | setVersionControl (KDevVersionControl *vcsToUse) |
Use the specified version control object as default vcs. | |
KDevVersionControl * | versionControlByName (const QString &uid) const |
Returns the Version Control System having the specified uinque identifier uid . | |
QStringList | registeredVersionControls () const |
Returns a list with unique identifiers among the version control systems. | |
void | unregisterVersionControl (KDevVersionControl *vcs) |
Remove (not delete) vcs to the list of the registered VCS. | |
KDevCodeRepository * | codeRepository () const |
Protected Member Functions | |
virtual void | showPart () |
This will cause the part to show up by calling KPart::show();. | |
Private Attributes | |
KDevApi * | m_api |
Private * | d |
Detailed Description
This is the base class for all components like doc tree view, LFV, RFV and so on.
Definition at line 60 of file kdevplugin.h.
Constructor & Destructor Documentation
|
Constructs a component.
Definition at line 58 of file kdevplugin.cpp. References KXMLGUIClient::actionCollection(), d, KDevPlugin::Private::dcopClient, KDevPlugin::Private::icon, KDevPlugin(), m_api, KDevPlugin::Private::name, KDevPlugin::Private::pluginName, and KActionCollection::setHighlightingEnabled(). Referenced by KDevPlugin(). |
|
Destructs a component.
Definition at line 74 of file kdevplugin.cpp. References d, and KDevPlugin::Private::dcopClient. |
Member Function Documentation
|
Reimplement this method if you want to add your credits to the KDevelop about dialog.
Definition at line 117 of file kdevplugin.h. |
|
Emitted when the part will be shown. If you really want to avoid that the part is shown at all, you will have to reimplement showPart(); |
|
Gives a reference to the application frontend component.
Definition at line 186 of file kdevplugin.cpp. References KDevApi::appFrontend(), and m_api. Referenced by TrollProjectWidget::slotDetailsContextMenu(), PascalProjectPart::slotExecute(), HaskellProjectPart::slotExecute(), CustomProjectPart::slotExecute(), AutoProjectPart::slotExecute(), AdaProjectPart::slotExecute(), AutoProjectPart::slotExecute2(), TrollProjectWidget::slotExecuteProject(), TrollProjectWidget::slotExecuteTarget(), GDBDebugger::DebuggerPart::slotRun(), RubySupportPart::startApplication(), PythonSupportPart::startApplication(), PerlSupportPart::startApplication(), BashSupportPart::startApplication(), and ToolsPart::startCommand(). |
|
|
|
Reimplement this method and return a QStringList of all config modules your application part should offer via KDevelop.
Note that the part and the module will have to take care for config syncing themselves. Usually
Definition at line 111 of file kdevplugin.h. |
|
|
Create the DCOP interface for the given Return false otherwise. Definition at line 99 of file kdevplugin.h. References createDCOPInterface(). Referenced by createDCOPInterface(). |
|
Returns a reference to the Create File API.
Definition at line 207 of file kdevplugin.cpp. References KDevApi::createFile(), and m_api. Referenced by AddMethodDialog::accept(), AutoDetailsView::slotAddNewFile(), TrollProjectWidget::slotDetailsContextMenu(), TrollProjectWidget::slotNewFile(), and GenericProjectWidget::slotNewFile(). |
|
Retrieve the current DCOP Client for the plugin. The clients name is taken from the name argument in the constructor.
Definition at line 110 of file kdevplugin.cpp. References d, KDevPlugin::Private::dcopClient, KDevPlugin::Private::name, and DCOPClient::registerAs(). |
|
Returns a reference to the debugger API.
Definition at line 200 of file kdevplugin.cpp. References KDevApi::debugger(), and m_api. Referenced by JAVADebugger::JavaDebuggerPart::slotRefreshBPState(), GDBDebugger::DebuggerPart::slotRefreshBPState(), JAVADebugger::JavaDebuggerPart::slotShowStep(), GDBDebugger::DebuggerPart::slotShowStep(), JAVADebugger::JavaDebuggerPart::slotStatus(), GDBDebugger::DebuggerPart::slotStatus(), JAVADebugger::JavaDebuggerPart::slotStop(), and GDBDebugger::DebuggerPart::slotStopDebugger(). |
|
Returns the description.
Definition at line 103 of file kdevplugin.cpp. |
|
Gives a reference to the diff frontend component.
Definition at line 179 of file kdevplugin.cpp. References KDevApi::diffFrontend(), and m_api. Referenced by CvsServicePartImpl::diffFrontend(), PerforcePart::slotDiffFinished(), and ClearcasePart::slotDiffFinished(). |
|
Returns the name of the icon.
Definition at line 89 of file kdevplugin.cpp. References d, and KDevPlugin::Private::icon. |
|
|
|
Indicates whether a valid main window is active.
Definition at line 130 of file kdevplugin.cpp. References m_api, and KDevApi::mainWindowValid(). |
|
|
reimplement and retun the part here.You can use this method if you need to access the current part.
Reimplemented in KNotesPlugin. Definition at line 123 of file kdevplugin.h. Referenced by showPart(). |
|
|
Offers access to KDevelop core.
Definition at line 82 of file kdevplugin.cpp. References d, and KDevPlugin::Private::pluginName. Referenced by MainWindowShare::slotStopMenuAboutToShow(), and MainWindowShare::slotStopPopupActivated(). |
|
|
|
Returns a list with unique identifiers among the version control systems.
Definition at line 242 of file kdevplugin.cpp. References m_api, and KDevApi::registeredVersionControls(). Referenced by AppWizardDialog::loadVcs(), and ImportDialog::scanAvailableVCS(). |
|
Add
Definition at line 228 of file kdevplugin.cpp. References m_api, KDevApi::registerVersionControl(), and registerVersionControl(). Referenced by registerVersionControl(). |
|
To restore any settings which differs from project to project, you can override this base class method to read in from a certain subtree of the project session file. During project loading, respectively project session (.kdevses) loading, this method will be called to give a chance to adapt the part to the newly loaded project. For instance, the debugger part might restore the set breakpoints from the previous debug session for the certain project.
Reimplemented in BookmarksPart, ValgrindPart, GDBDebugger::DebuggerPart, AutoProjectPart, and subversionPart. Definition at line 256 of file kdevplugin.cpp. References restorePartialProjectSession(). Referenced by ProjectSession::restoreFromFile(), and restorePartialProjectSession(). |
|
Reimplemented in BookmarksPart, ValgrindPart, GDBDebugger::DebuggerPart, AutoProjectPart, and subversionPart. Definition at line 263 of file kdevplugin.cpp. References savePartialProjectSession(). Referenced by savePartialProjectSession(), and ProjectSession::saveToFile(). |
|
Use the specified version control object as default vcs.
Definition at line 221 of file kdevplugin.cpp. References m_api, KDevApi::setVersionControl(), and setVersionControl(). Referenced by setVersionControl(). |
|
Returns the short description.
Reimplemented in PerforcePart. Definition at line 96 of file kdevplugin.cpp. Referenced by showPart(). |
|
This will cause the part to show up by calling KPart::show();.
Definition at line 270 of file kdevplugin.cpp. References d, part(), partController(), KDevPlugin::Private::pluginName, shortDescription(), and KDevPartController::showPart(). Referenced by KNotesPlugin::slotNewNote(), and KNotesPlugin::slotShowNotes(). |
|
Returns a reference to the source formatter.
Definition at line 278 of file kdevplugin.cpp. References m_api, and KDevApi::sourceFormatter(). Referenced by SubclassingDlg::accept(), CppNewClassDialog::ClassGenerator::gen_implementation(), and CppNewClassDialog::ClassGenerator::gen_interface(). |
|
Remove (not delete)
Definition at line 235 of file kdevplugin.cpp. References m_api, KDevApi::unregisterVersionControl(), and unregisterVersionControl(). Referenced by unregisterVersionControl(). |
|
Add to the list of the registered VCS.
Definition at line 214 of file kdevplugin.cpp. References m_api, and KDevApi::versionControl(). Referenced by PartWidget::PartWidget(), and FileTreeWidget::versionControl(). |
|
Returns the Version Control System having the specified uinque identifier
Definition at line 249 of file kdevplugin.cpp. References m_api, KDevApi::versionControlByName(), and versionControlByName(). Referenced by AppWizardDialog::accept(), AppWizardDialog::loadVcs(), ImportDialog::slotFetchModulesFromRepository(), and versionControlByName(). |
|
Returns the widget of the plugin. This must be overridden. Reimplemented in KDevMakeFrontend, and MakeViewPart. Definition at line 139 of file kdevplugin.h. |
Member Data Documentation
|
Reimplemented in AdaSupportPart, and PascalSupportPart. Definition at line 277 of file kdevplugin.h. Referenced by dcopClient(), icon(), KDevPlugin(), pluginName(), showPart(), and ~KDevPlugin(). |
|
Definition at line 275 of file kdevplugin.h. Referenced by appFrontend(), codeModel(), codeRepository(), core(), createFileSupport(), debugger(), diffFrontend(), KDevPlugin(), languageSupport(), mainWindow(), mainWindowValid(), makeFrontend(), partController(), project(), projectDom(), registeredVersionControls(), registerVersionControl(), setVersionControl(), sourceFormatter(), unregisterVersionControl(), versionControl(), and versionControlByName(). |
The documentation for this class was generated from the following files:
- lib/interfaces/kdevplugin.h
- lib/interfaces/kdevplugin.cpp