#include <kdevcore.h>
Inherits TQObject.
Signals | |
void | coreInitialized () |
void | projectOpened () |
void | projectClosed () |
void | languageChanged () |
void | stopButtonClicked (KDevPlugin *which) |
void | contextMenu (TQPopupMenu *popupMenu, const Context *context) |
void | configWidget (KDialogBase *dlg) |
void | projectConfigWidget (KDialogBase *dlg) |
Public Member Functions | |
KDevCore (TQObject *parent=0, const char *name=0) | |
virtual | ~KDevCore () |
virtual void | fillContextMenu (TQPopupMenu *popup, const Context *context)=0 |
virtual void | openProject (const TQString &projectFileName)=0 |
virtual void | running (KDevPlugin *which, bool runs)=0 |
Detailed Description
A KDevCore class defines an object which takes care about the cooperation between the various plug-in which compose KDevelop.
It defines:
- signals that can be captured for menu customization;
- notifications about opening / closing projects;
- methods to access functionality of KDevelop core;
- requests to fill project and global settings widgets;
- etc.
Definition at line 300 of file kdevcore.h.
Constructor & Destructor Documentation
◆ KDevCore()
KDevCore::KDevCore | ( | TQObject * | parent = 0 , |
const char * | name = 0 |
||
) |
Constructor.
- Parameters
-
parent The TQObject that's the parent of this class. name The name of the class.
Definition at line 288 of file kdevcore.cpp.
◆ ~KDevCore()
|
virtual |
Destructor.
Definition at line 294 of file kdevcore.cpp.
Member Function Documentation
◆ configWidget
|
signal |
Expects that a configuration page for use in the KDevelop settings dialog is created by the component.
The configuration page is not demand-loading, it will be created before global settings dialog is shown. Use ConfigWidgetProxy in your plugin to create demand-loading configuration pages.
- Parameters
-
dlg The dialog which the configuration widget should be added to.
◆ contextMenu
|
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.
- See also
- Context for a detailed explanation of context menu initializations and usage.
- Parameters
-
popupMenu The popup menu to fill. context The Context of this popup menu.
◆ coreInitialized
|
signal |
Emitted after the core has done all initializations and the main window has been shown.
◆ fillContextMenu()
|
pure virtual |
Fills the context menu.
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.
- See also
- Context for a detailed explanation of context menu initializations and usage.
- Parameters
-
popup The popup menu to fill. context The pointer to a Context object of this popup menu.
◆ languageChanged
|
signal |
The language support part has been changed.
◆ openProject()
|
pure virtual |
Closes the current project and open the new one.
You cannot use the KDevPlugin::project() method right after opening a new project, as it will return a null pointer. You must wait for the eventloop to be reentered, so use a signleshot timer to do the job needed after the project is opened or connect a slot to the projectOpened signal.
- Parameters
-
projectFileName The file name of the project to open.
◆ projectClosed
|
signal |
The project is about to be closed.
◆ projectConfigWidget
|
signal |
Expects that a configuration page for use in the Project settings dialog is created by the component.
The configuration page is not demand-loading, it will be created before project settings dialog is shown. Use ConfigWidgetProxy in your plugin to create demand-loading configuration pages.
- Parameters
-
dlg The dialog which the configuration widget should be added to.
◆ projectOpened
|
signal |
A project has been opened.
◆ running()
|
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, component get a stopButtonClicked(). This is usable for plugins which run certain commands and want KDevelop core to be notified of that. If core is notified, it can allow the user to stop(interrupt) the command manually by means of stop button.
- Parameters
-
which The plugin to mark. runs true if plugin is running something, false if it is not.
◆ stopButtonClicked
|
signal |
The user has clicked the stop button.
If all actions should be cancelled, pass 0 to which
- Parameters
-
which The KDevPlugin object to stop.
The documentation for this class was generated from the following files: