KDevelop API Documentation

KDevBuildSystem Class Reference

Interface to a build system plugin for KDevelop Generic Project Manager. More...

#include <kdevbuildsystem.h>

Inheritance diagram for KDevBuildSystem:

QObject ShellScriptBuildSystem List of all members.

Public Member Functions

 KDevBuildSystem (QObject *parent=0, const char *name=0)
virtual ~KDevBuildSystem ()
virtual void initProject (KDevProject *project)
virtual KDevProjectproject ()
virtual QString buildSystemName ()=0
 the name of the build system for using in project configuration files

virtual void createBuildSystem (BuildBaseItem *)=0
 reimplement this to create your build system like makefiles ant's xml files or shell scripts to build the currently selected project item (like target or group)

virtual void build (BuildBaseItem *it=0)=0
 implement this to allow building of files, targets and groups

virtual void install (BuildBaseItem *it=0)=0
 implement this to allow installing of targets and groups

virtual void execute (BuildBaseItem *it=0)=0
 implement this to allow executing of targets and groups

virtual void clean (BuildBaseItem *it=0)=0
 implement this to allow cleaning of targets and groups

virtual void configureBuildItem (KDialogBase *, BuildBaseItem *)
 reimplement to show configure build item dialog

virtual QValueList< ProjectConfigTab * > confWidgets ()=0
 reimplement to include project configuration widgets that will be included in Project|Project Options|Configure Options all those widgets will go to the tab bar below the configuration profiles widget

virtual void addDefaultBuildWidget (KDialogBase *dlg, QWidget *parent, BuildBaseItem *)
 this provides a simple propery editor for the given build item if the build system don't want to provide its own configuration widget (there is no need to reimplement this)


Protected Member Functions

virtual void updateDefaultBuildWidget ()

Private Attributes

KDevProjectm_project

Detailed Description

Interface to a build system plugin for KDevelop Generic Project Manager.

Generic project manager is a project manager that offers an unique interface to various build systems like make, ant, cook, shell scripts, etc. KDevBuildSystem is an interface for the generic build operations that are necessary for a build system plugin to work with generic manager.

Definition at line 183 of file kdevbuildsystem.h.


Constructor & Destructor Documentation

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

Definition at line 185 of file kdevbuildsystem.cpp.

References KDevBuildSystem().

Referenced by KDevBuildSystem().

KDevBuildSystem::~KDevBuildSystem  )  [virtual]
 

Definition at line 181 of file kdevbuildsystem.cpp.


Member Function Documentation

void KDevBuildSystem::addDefaultBuildWidget KDialogBase dlg,
QWidget parent,
BuildBaseItem
[virtual]
 

this provides a simple propery editor for the given build item if the build system don't want to provide its own configuration widget (there is no need to reimplement this)

Definition at line 174 of file kdevbuildsystem.cpp.

References addDefaultBuildWidget().

Referenced by addDefaultBuildWidget(), and configureBuildItem().

virtual void KDevBuildSystem::build BuildBaseItem it = 0  )  [pure virtual]
 

implement this to allow building of files, targets and groups

Implemented in ShellScriptBuildSystem.

Referenced by GenericProjectWidget::slotBuild(), GenericProjectWidget::slotBuildFile(), GenericProjectWidget::slotBuildGroup(), and GenericProjectWidget::slotBuildTarget().

virtual QString KDevBuildSystem::buildSystemName  )  [pure virtual]
 

the name of the build system for using in project configuration files

Implemented in ShellScriptBuildSystem.

virtual void KDevBuildSystem::clean BuildBaseItem it = 0  )  [pure virtual]
 

implement this to allow cleaning of targets and groups

Implemented in ShellScriptBuildSystem.

Referenced by GenericProjectWidget::slotClean(), GenericProjectWidget::slotCleanGroup(), and GenericProjectWidget::slotCleanTarget().

void KDevBuildSystem::configureBuildItem KDialogBase ,
BuildBaseItem
[virtual]
 

reimplement to show configure build item dialog

Reimplemented in ShellScriptBuildSystem.

Definition at line 190 of file kdevbuildsystem.cpp.

References addDefaultBuildWidget(), KDialogBase::addVBoxPage(), and configureBuildItem().

Referenced by configureBuildItem(), GenericProjectWidget::slotConfigureFile(), GenericProjectWidget::slotConfigureGroup(), and GenericProjectWidget::slotConfigureTarget().

virtual QValueList<ProjectConfigTab *> KDevBuildSystem::confWidgets  )  [pure virtual]
 

reimplement to include project configuration widgets that will be included in Project|Project Options|Configure Options all those widgets will go to the tab bar below the configuration profiles widget

Implemented in ShellScriptBuildSystem.

virtual void KDevBuildSystem::createBuildSystem BuildBaseItem  )  [pure virtual]
 

reimplement this to create your build system like makefiles ant's xml files or shell scripts to build the currently selected project item (like target or group)

Implemented in ShellScriptBuildSystem.

virtual void KDevBuildSystem::execute BuildBaseItem it = 0  )  [pure virtual]
 

implement this to allow executing of targets and groups

Implemented in ShellScriptBuildSystem.

Referenced by GenericProjectWidget::slotExecute(), GenericProjectWidget::slotExecuteGroup(), and GenericProjectWidget::slotExecuteTarget().

void KDevBuildSystem::initProject KDevProject project  )  [virtual]
 

Definition at line 201 of file kdevbuildsystem.cpp.

References initProject(), and m_project.

Referenced by initProject(), and GenericProjectPart::openProject().

virtual void KDevBuildSystem::install BuildBaseItem it = 0  )  [pure virtual]
 

implement this to allow installing of targets and groups

Implemented in ShellScriptBuildSystem.

Referenced by GenericProjectWidget::slotInstall(), GenericProjectWidget::slotInstallGroup(), and GenericProjectWidget::slotInstallTarget().

KDevProject * KDevBuildSystem::project  )  [virtual]
 

Definition at line 206 of file kdevbuildsystem.cpp.

References m_project.

void KDevBuildSystem::updateDefaultBuildWidget  )  [protected, virtual]
 

Definition at line 211 of file kdevbuildsystem.cpp.


Member Data Documentation

KDevProject* KDevBuildSystem::m_project [private]
 

Definition at line 231 of file kdevbuildsystem.h.

Referenced by initProject(), and project().


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:22 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003