kdevplatform/project
#include <builderjob.h>

Public Types | |
enum | BuildType { Build, Prune, Configure, Install, Clean } |
Public Member Functions | |
BuilderJob () | |
~BuilderJob () override | |
void | addCustomJob (BuildType type, KJob *job, ProjectBaseItem *item=nullptr) |
void | addItem (BuildType type, ProjectBaseItem *item) |
void | addItems (BuildType type, const QList< KDevelop::ProjectBaseItem * > &items) |
void | addProjects (BuildType type, const QList< KDevelop::IProject * > &projects) |
void | start () override |
void | updateJobName () |
Detailed Description
Allows to build a list of project items or projects sequentially, where failing to build one item in the list will fail the whole job.
Definition at line 54 of file builderjob.h.
Member Enumeration Documentation
◆ BuildType
Defines what action to do on the Project builder.
Enumerator | |
---|---|
Build | Build the selected items. |
Prune | Prune the selected items. |
Configure | Configure the selected items. |
Install | Install the selected items. |
Clean | Clean the selected items. |
Definition at line 61 of file builderjob.h.
Constructor & Destructor Documentation
◆ BuilderJob()
BuilderJob::BuilderJob | ( | ) |
Creates a Builder job.
Definition at line 147 of file builderjob.cpp.
◆ ~BuilderJob()
|
overridedefault |
Member Function Documentation
◆ addCustomJob()
void BuilderJob::addCustomJob | ( | BuilderJob::BuildType | type, |
KJob * | job, | ||
ProjectBaseItem * | item = nullptr |
||
) |
Allows to add a custom job
to the end of the list.
The build method specified by type
and (optionally) an item specified by item
are needed to create a human-readable job name.
- Parameters
-
type The build method which is represented by the job
job The job to add to the list item The item which is build by the job
Definition at line 179 of file builderjob.cpp.
◆ addItem()
void BuilderJob::addItem | ( | BuildType | type, |
ProjectBaseItem * | item | ||
) |
Allows to add a single item
to the end of the list.
The item will be built using the method identified by type
- Parameters
-
item The item to add to the list type The build method to be used for the item
Definition at line 172 of file builderjob.cpp.
◆ addItems()
void BuilderJob::addItems | ( | BuildType | type, |
const QList< KDevelop::ProjectBaseItem * > & | items | ||
) |
Allows to easily schedule building a couple of items
using the method identified by type
.
- Parameters
-
type the build method to use items the project items to add
Definition at line 154 of file builderjob.cpp.
◆ addProjects()
Allows to easily schedule building a couple of projects
using the method identified by type
.
- Parameters
-
type the build method to use projects the projects to add
Definition at line 163 of file builderjob.cpp.
◆ start()
|
override |
Starts this job.
Definition at line 263 of file builderjob.cpp.
◆ updateJobName()
void BuilderJob::updateJobName | ( | ) |
Updates the job's name.
Shall be called before registering this job in the run controller, but after adding all required tasks to the job.
Definition at line 213 of file builderjob.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Apr 13 2021 23:30:29 by doxygen 1.8.16 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.