KDE 4.2 API Reference project
KDevelop::IProjectBuilder Class Reference
#include <iprojectbuilder.h>
Detailed Description
IProjectBuilder Base class for the Project Builders
Describes a Project Builder to KDevelop's Project Manager.
Definition at line 40 of file iprojectbuilder.h.
Signals | |
| void | built (ProjectBaseItem *dom) |
| void | cleaned (ProjectBaseItem *) |
| void | configured (IProject *) |
| void | failed (ProjectBaseItem *dom) |
| void | installed (ProjectBaseItem *) |
| void | pruned (IProject *) |
Public Member Functions | |
| virtual KJob * | build (ProjectBaseItem *dom)=0 |
| virtual KJob * | clean (ProjectBaseItem *dom)=0 |
| virtual KJob * | configure (IProject *) |
| virtual KJob * | install (ProjectBaseItem *item)=0 |
| virtual KJob * | prune (IProject *) |
Member Function Documentation
| virtual KJob* KDevelop::IProjectBuilder::build | ( | ProjectBaseItem * | dom | ) | [pure virtual] |
Builds the given project item, exact behaviour depends on the implementation.
| void KDevelop::IProjectBuilder::built | ( | ProjectBaseItem * | dom | ) | [signal] |
Emitted when the build for the given item was finished.
| virtual KJob* KDevelop::IProjectBuilder::clean | ( | ProjectBaseItem * | dom | ) | [pure virtual] |
Cleans the given project item, exact behaviour depends on the implementation.
The cleaning should only include output files, like C/C++ object files, binaries, files that the builder needs shouldn't be removed.
| void KDevelop::IProjectBuilder::cleaned | ( | ProjectBaseItem * | ) | [signal] |
Emitted when the clean for the given item was finished.
| KJob * KDevelop::IProjectBuilder::configure | ( | IProject * | ) | [virtual] |
Configures the given project, exact behaviour depends on the implementation.
After calling this a build() call should succeed (given the code doesn't have errors).
This function is optional, the default implementation does nothing.
Definition at line 29 of file iprojectbuilder.cpp.
| void KDevelop::IProjectBuilder::configured | ( | IProject * | ) | [signal] |
Emitted when the configure for the given item was finished.
| void KDevelop::IProjectBuilder::failed | ( | ProjectBaseItem * | dom | ) | [signal] |
Emitted when any of the scheduled actions for the given item was failed.
| virtual KJob* KDevelop::IProjectBuilder::install | ( | ProjectBaseItem * | item | ) | [pure virtual] |
Installs the given project item, exact behaviour depends on the implementation.
| void KDevelop::IProjectBuilder::installed | ( | ProjectBaseItem * | ) | [signal] |
Emitted when the install for the given item was finished.
| KJob * KDevelop::IProjectBuilder::prune | ( | IProject * | ) | [virtual] |
Prunes the given project, exact behaviour depends on the implementation.
Additionally to what clean() does this may also remove files used for the builder (or a "subbuilder"), for example generated Makefiles in QMake/CMake/Automake projects
This function is optional, the default implementation does nothing.
Definition at line 34 of file iprojectbuilder.cpp.
| void KDevelop::IProjectBuilder::pruned | ( | IProject * | ) | [signal] |
Emitted when the pruning for the given item was finished.
The documentation for this class was generated from the following files:
