• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • TDevelop Interfaces Library
 

TDevelop Interfaces Library

Signals | Public Member Functions | List of all members
KDevCore Class Referenceabstract

#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
parentThe TQObject that's the parent of this class.
nameThe name of the class.

Definition at line 288 of file kdevcore.cpp.

◆ ~KDevCore()

KDevCore::~KDevCore ( )
virtual

Destructor.

Definition at line 294 of file kdevcore.cpp.

Member Function Documentation

◆ configWidget

void KDevCore::configWidget ( KDialogBase *  dlg)
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
dlgThe dialog which the configuration widget should be added to.

◆ contextMenu

void KDevCore::contextMenu ( TQPopupMenu *  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.

See also
Context for a detailed explanation of context menu initializations and usage.
Parameters
popupMenuThe popup menu to fill.
contextThe Context of this popup menu.

◆ coreInitialized

void KDevCore::coreInitialized ( )
signal

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

◆ fillContextMenu()

virtual void KDevCore::fillContextMenu ( TQPopupMenu *  popup,
const Context *  context 
)
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
popupThe popup menu to fill.
contextThe pointer to a Context object of this popup menu.

◆ languageChanged

void KDevCore::languageChanged ( )
signal

The language support part has been changed.

◆ openProject()

virtual void KDevCore::openProject ( const TQString &  projectFileName)
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
projectFileNameThe file name of the project to open.

◆ projectClosed

void KDevCore::projectClosed ( )
signal

The project is about to be closed.

◆ projectConfigWidget

void KDevCore::projectConfigWidget ( KDialogBase *  dlg)
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
dlgThe dialog which the configuration widget should be added to.

◆ projectOpened

void KDevCore::projectOpened ( )
signal

A project has been opened.

◆ running()

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, 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
whichThe plugin to mark.
runstrue if plugin is running something, false if it is not.

◆ stopButtonClicked

void KDevCore::stopButtonClicked ( KDevPlugin *  which)
signal

The user has clicked the stop button.

If all actions should be cancelled, pass 0 to which

Parameters
whichThe KDevPlugin object to stop.

The documentation for this class was generated from the following files:
  • kdevcore.h
  • kdevcore.cpp

TDevelop Interfaces Library

Skip menu "TDevelop Interfaces Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

TDevelop Interfaces Library

Skip menu "TDevelop Interfaces Library"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for TDevelop Interfaces Library by doxygen 1.8.13
This website is maintained by Timothy Pearson.