KDevelop API Documentation

KDevCore Class Reference

A KDevCore class defines an object which is used to realized the cooperation between the various plug-in which compose KDevelop: it defines virtual function, signals that can be captured for menu customization, GUI utility functions for adding new KActions, ... More...

#include <kdevcore.h>

Inheritance diagram for KDevCore:

Inheritance graph
[legend]
Collaboration diagram for KDevCore:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Embedding { Replace, SplitHorizontal, SplitVertical }
 An enumeration that specifies the behaviour of the methods gotoSourceFile() and gotoDocumentationFile(). More...

Signals

void coreInitialized ()
 Emitted after the core has done all initializations and the main window has been shown.
void projectOpened ()
 A project has been opened.
void projectClosed ()
 The project is about to be closed.
void languageChanged ()
 The language support part has been changed.
void stopButtonClicked (KDevPlugin *which)
 The user has clicked the stop button.
void contextMenu (QPopupMenu *popupMenu, const Context *context)
 A context menu has been requested somewhere.
void configWidget (KDialogBase *dlg)
 Expects that a configuration page for use in the KDevelop settings dialog is created by the component.
void projectConfigWidget (KDialogBase *dlg)
 Expects that a configuration page for use in the Project settings dialog is created by the component.

Public Member Functions

 KDevCore (QObject *parent=0, const char *name=0)
 Constructor.
virtual ~KDevCore ()
 Destructor.
virtual void insertNewAction (KAction *action)=0
virtual void fillContextMenu (QPopupMenu *popup, const Context *context)=0
 This method should be called by a part that wants to show a context menu.
virtual void openProject (const QString &projectFileName)=0
 close the current project and opens the new one
virtual void running (KDevPlugin *which, bool runs)=0
 Marks the component as running (or not running).
virtual QDict< KDevLicenselicenses ()=0
 Returns a list of all available licenses.

Detailed Description

A KDevCore class defines an object which is used to realized the cooperation between the various plug-in which compose KDevelop: it defines virtual function, signals that can be captured for menu customization, GUI utility functions for adding new KActions, ...

Definition at line 295 of file kdevcore.h.


Member Enumeration Documentation

enum KDevCore::Embedding
 

An enumeration that specifies the behaviour of the methods gotoSourceFile() and gotoDocumentationFile().

Enumeration values:
Replace 
SplitHorizontal 
SplitVertical 

Definition at line 304 of file kdevcore.h.


Constructor & Destructor Documentation

KDevCore::KDevCore QObject parent = 0,
const char *  name = 0
 

Constructor.

Parameters:
parent 
name 

Definition at line 336 of file kdevcore.cpp.

KDevCore::~KDevCore  )  [virtual]
 

Destructor.

Definition at line 344 of file kdevcore.cpp.


Member Function Documentation

void KDevCore::configWidget KDialogBase dlg  )  [signal]
 

Expects that a configuration page for use in the KDevelop settings dialog is created by the component.

Parameters:
dlg the dialog which the configuration widget should be added to

Referenced by Core::doEmitConfigWidget().

void KDevCore::contextMenu QPopupMenu popupMenu,
const Context context
[signal]
 

A context menu has been requested somewhere.

Components may hook some entries into it. More information on the context can be obtained by looking for the type of context and casting it accordingly.

Referenced by Core::fillContextMenu().

void KDevCore::coreInitialized  )  [signal]
 

Emitted after the core has done all initializations and the main window has been shown.

Referenced by Core::doEmitCoreInitialized().

virtual void KDevCore::fillContextMenu QPopupMenu popup,
const Context context
[pure virtual]
 

This method should be called by a part that wants to show a context menu.

The parameter context should be filled with information about the context in which this happens (see EditorContext, DocumentationContext, ClassContext, ...). Essentially, this method emits the signal contextMenu() which other parts can use to hook in.

Implemented in Core.

Referenced by KDevDirOperator::activatedMenu(), ClassViewWidget::contentsContextMenuEvent(), FileListWidget::popupMenu(), FileTreeWidget::slotContextMenu(), FileGroupsWidget::slotContextMenu(), DocTreeViewWidget::slotContextMenu(), TrollProjectWidget::slotDetailsContextMenu(), and AutoDetailsView::slotDetailsContextMenu().

virtual void KDevCore::insertNewAction KAction action  )  [pure virtual]
 

Parameters:
action 

Implemented in Core.

Referenced by ScriptingPart::addMenuItem(), and KNotesPlugin::KNotesPlugin().

void KDevCore::languageChanged  )  [signal]
 

The language support part has been changed.

Referenced by Core::doEmitLanguageChanged().

virtual QDict< KDevLicense > KDevCore::licenses  )  [pure virtual]
 

Returns a list of all available licenses.

Implemented in Core.

Referenced by AppWizardDialog::accept(), AppWizardDialog::AppWizardDialog(), and AppWizardDialog::licenseChanged().

virtual void KDevCore::openProject const QString projectFileName  )  [pure virtual]
 

close the current project and opens the new one

Implemented in Core.

Referenced by ImportDialog::accept(), and AppWizardDialog::openAfterGeneration().

void KDevCore::projectClosed  )  [signal]
 

The project is about to be closed.

Referenced by Core::doEmitProjectClosed().

void KDevCore::projectConfigWidget KDialogBase dlg  )  [signal]
 

Expects that a configuration page for use in the Project settings dialog is created by the component.

Parameters:
dlg the dialog which the configuration widget should be added to

Referenced by Core::doEmitProjectConfigWidget().

void KDevCore::projectOpened  )  [signal]
 

A project has been opened.

Referenced by Core::doEmitProjectOpened().

virtual void KDevCore::running KDevPlugin which,
bool  runs
[pure virtual]
 

Marks the component as running (or not running).

As long as at least one component is running, the stop button is enabled. When it is pressed, all components get a stopButtonClicked().

Implemented in Core.

Referenced by CvsProcessWidget::cancelJob(), GrepViewWidget::childFinished(), ReplaceWidget::makeReplacements(), ValgrindPart::processExited(), ValgrindPart::runValgrind(), GrepViewWidget::searchActivated(), ReplaceWidget::showReplacements(), CvsServicePartImpl::slotDiffFinished(), CvsProcessWidget::slotJobExited(), MakeWidget::slotProcessExited(), AppOutputViewPart::slotProcessExited(), JAVADebugger::JavaDebuggerPart::slotStop(), GDBDebugger::DebuggerPart::slotStopDebugger(), AppOutputViewPart::startAppCommand(), JAVADebugger::JavaDebuggerPart::startDebugger(), GDBDebugger::DebuggerPart::startDebugger(), CvsProcessWidget::startJob(), MakeWidget::startNextJob(), and AppOutputViewPart::stopApplication().

void KDevCore::stopButtonClicked KDevPlugin which  )  [signal]
 

The user has clicked the stop button.

Parameters:
which is 0 if all actions should be cancelled.

Referenced by Core::doEmitStopButtonPressed().


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 Tue Feb 22 09:39:50 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003