GenericProjectPart Class Reference
Generic build tool part Put a more detailed description of your part in these lines. More...
#include <genericproject_part.h>
Inheritance diagram for GenericProjectPart:


Signals | |
void | mainGroupChanged (BuildGroupItem *group) |
Public Member Functions | |
GenericProjectPart (QObject *parent, const char *name, const QStringList &) | |
virtual | ~GenericProjectPart () |
BuildGroupItem * | mainGroup () |
virtual void | openProject (const QString &dirName, const QString &projectName) |
This method is invoked when the project is opened (i.e. | |
virtual void | closeProject () |
This method is invoked when the project is about to be closed. | |
virtual QString | projectDirectory () const |
Returns the canonical toplevel directory of the project. | |
virtual QString | projectName () const |
Returns the name of the project. | |
virtual DomUtil::PairList | runEnvironmentVars () const |
The environment variables that sould be set before running mainProgram(). | |
virtual QString | mainProgram (bool relative=false) const |
Returns the absolute path to main binary program of the project. | |
virtual QString | runDirectory () const |
Absolute path (directory) from where the mainProgram() should be run. | |
virtual QString | runArguments () const |
The command line arguments that the mainProgram() should be run with. | |
virtual QString | activeDirectory () const |
Returns the path (relative to the project directory) of the active directory. | |
virtual QString | buildDirectory () const |
Returns the canonical build directory of the project. | |
virtual QStringList | allFiles () const |
Returns a list of all files in the project. | |
virtual void | addFiles (const QStringList &fileList) |
Adds a list of files to the project. | |
virtual void | addFile (const QString &fileName) |
Adds a file to the project. | |
virtual void | removeFiles (const QStringList &fileList) |
Removes a list of files from the project. | |
virtual void | removeFile (const QString &fileName) |
Removes a file from the project. | |
KDevBuildSystem * | buildSystem () const |
QStringList | distFiles () const |
Returns a list of files that are part of the distribution but not under project control. | |
Private Member Functions | |
QStringList | allFiles (BuildGroupItem *group, QStringList &path) const |
QStringList | allFiles (BuildTargetItem *target, QStringList &path) const |
void | loadProjectConfig (QString projectFile) |
void | parseGroup (const QDomElement &el, const GenericGroupListViewItem *parentGroup) |
void | parseTarget (const QDomElement &el, BuildGroupItem *group) |
void | parseFile (const QDomElement &el, BuildTargetItem *target) |
GenericGroupListViewItem * | createGroupItem (const QDomElement &el, const GenericGroupListViewItem *parent=0) |
BuildTargetItem * | createTargetItem (const QDomElement &el, BuildGroupItem *group) |
BuildFileItem * | createFileItem (const QDomElement &el, BuildTargetItem *target) |
void | addFilePrivate (const QString &fileName, BuildTargetItem *tit) |
Private Attributes | |
KDevBuildSystem * | m_buildSystem |
QGuardedPtr< GenericProjectWidget > | m_widget |
GenericGroupListViewItem * | m_mainGroup |
BuildGroupItem * | m_mainBuild |
QString | m_buildDir |
QString | m_projectDir |
QString | m_projectName |
QString | m_activeDir |
QString | m_runDir |
Detailed Description
Generic build tool part Put a more detailed description of your part in these lines.
It can span over several lines. You can even use some html commands in these lines like: This is code
, html links link text, and images.
- Feature(s):
- Describe the first feature
Describe the second feature ...
Describe the last feature
- Bug:
- Describe a the 1st bug that you know of, but probably hasn't been reported yet. ..
Describe a the nth bug that you know of, but probably hasn't been reported yet.
- Requirement(s):
- Describe a the 1st requirement of your part.
Describe a the 2nd requirement of your part. ...
Describe a the nth requirement of your part.
- Todo:
- Describe a the 1st TODO of your part.
Describe a the 2nd TODO of your part. ...
Describe a the nth TODO of your part.
- F.A.Q.:
- First frequenly asked question about your part ? Answer.
Second frequenly asked question about your part ? Answer. ...
Last frequenly asked question about your part ? Answer.
- Note:
- First note text.
Second note text. ...
Last note text.
- Warning:
- First warning text.
Second warning text. ...
Last warning text.
Definition at line 27 of file genericproject_part.h.
Constructor & Destructor Documentation
|
|
|
Definition at line 72 of file genericproject_part.cpp. References m_widget, KDevPlugin::mainWindow(), and KDevMainWindow::removeView(). |
Member Function Documentation
|
Returns the path (relative to the project directory) of the active directory. All newly generated classes are added here. Implements KDevProject. Definition at line 181 of file genericproject_part.cpp. |
|
Adds a file to the project. The given file name must be relative to the project directory. Implements KDevProject. Definition at line 216 of file genericproject_part.cpp. References addFiles(). |
|
Definition at line 223 of file genericproject_part.cpp. References kdDebug(), m_widget, KURL::prettyURL(), projectDirectory(), and KURL::setPath(). Referenced by addFiles(). |
|
Adds a list of files to the project. Provided for convenience when adding many files. The given file names must be relative to the project directory. Implements KDevProject. Definition at line 197 of file genericproject_part.cpp. References KDevProject::addedFilesToProject(), addFilePrivate(), BuildTargetItem::fileByName(), kdDebug(), m_projectDir, and m_widget. Referenced by addFile(), and GenericProjectWidget::slotAddFiles(). |
|
Definition at line 383 of file genericproject_part.cpp. References file, BuildTargetItem::files(), m_projectDir, KURL::path(), and BuildFileItem::url(). |
|
Definition at line 358 of file genericproject_part.cpp. References allFiles(), BuildGroupItem::groups(), BuildBaseItem::name(), and BuildGroupItem::targets(). |
|
Returns a list of all files in the project. The files are relative to the project directory. Implements KDevProject. Definition at line 191 of file genericproject_part.cpp. References m_mainBuild. Referenced by allFiles(), and distFiles(). |
|
Returns the canonical build directory of the project. If the separate build directory is not supported, this should return the same as projectDiretory(). Implements KDevProject. Definition at line 186 of file genericproject_part.cpp. |
|
|
This method is invoked when the project is about to be closed.
Implements KDevProject. Definition at line 147 of file genericproject_part.cpp. |
|
Definition at line 343 of file genericproject_part.cpp. References kdDebug(), BuildTargetItem::parentGroup(), BuildBaseItem::path(), projectDirectory(), and KURL::setPath(). Referenced by parseFile(). |
|
Definition at line 315 of file genericproject_part.cpp. References GenericGroupListViewItem::groupItem(), kdDebug(), VariantSerializer::loadValue(), m_widget, and BuildBaseItem::setAttribute(). Referenced by parseGroup(). |
|
Definition at line 337 of file genericproject_part.cpp. Referenced by parseTarget(). |
|
Returns a list of files that are part of the distribution but not under project control.
Implements KDevProject. Definition at line 403 of file genericproject_part.cpp. References allFiles(), and projectDirectory(). |
|
Definition at line 243 of file genericproject_part.cpp. References kdDebug(), m_mainGroup, DomUtil::openDOMFile(), parseGroup(), projectDirectory(), and QDomDocument_toString(). Referenced by openProject(). |
|
Definition at line 34 of file genericproject_part.h. |
|
|
|
Returns the absolute path to main binary program of the project.
Implements KDevProject. Definition at line 166 of file genericproject_part.cpp. |
|
This method is invoked when the project is opened (i.e. actually just after this class has been instantiated). The first parameter is the project directory, which should afterwards be returned by the projectDirectory() method. The second parameter is the project name, which is equivalent with the project file name without the .kdevelop suffix. Reimplemented from KDevProject. Definition at line 85 of file genericproject_part.cpp. References KDevBuildSystem::initProject(), kdDebug(), loadProjectConfig(), m_buildDir, m_buildSystem, m_projectDir, m_projectName, KDevProject::openProject(), KDevPlugin::projectDom(), KService::Ptr, DomUtil::readEntry(), and KMessageBox::sorry(). |
|
Definition at line 310 of file genericproject_part.cpp. References createFileItem(). Referenced by parseTarget(). |
|
Definition at line 268 of file genericproject_part.cpp. References createGroupItem(), GenericGroupListViewItem::groupItem(), kdDebug(), and parseTarget(). Referenced by loadProjectConfig(). |
|
Definition at line 292 of file genericproject_part.cpp. References createTargetItem(), kdDebug(), and parseFile(). Referenced by parseGroup(). |
|
Returns the canonical toplevel directory of the project.
Implements KDevProject. Definition at line 151 of file genericproject_part.cpp. Referenced by addFilePrivate(), createFileItem(), distFiles(), loadProjectConfig(), GenericProjectWidget::slotAddFiles(), GenericProjectWidget::slotDeleteGroup(), GenericProjectWidget::slotNewFile(), GenericProjectWidget::slotNewGroup(), and GenericProjectWidget::takeTarget(). |
|
Returns the name of the project.
Implements KDevProject. Definition at line 156 of file genericproject_part.cpp. |
|
Removes a file from the project. The given file name must be relative to the project directory. Implements KDevProject. Definition at line 237 of file genericproject_part.cpp. References removeFiles(). |
|
Removes a list of files from the project. Provided for convenience when removing many files. The given file names must be relative to the project directory. Implements KDevProject. Definition at line 233 of file genericproject_part.cpp. Referenced by removeFile(). |
|
The command line arguments that the mainProgram() should be run with.
Implements KDevProject. Definition at line 176 of file genericproject_part.cpp. |
|
Absolute path (directory) from where the mainProgram() should be run.
Implements KDevProject. Definition at line 171 of file genericproject_part.cpp. |
|
The environment variables that sould be set before running mainProgram().
Implements KDevProject. Definition at line 161 of file genericproject_part.cpp. References DomUtil::PairList. |
Member Data Documentation
|
Definition at line 85 of file genericproject_part.h. |
|
Definition at line 82 of file genericproject_part.h. Referenced by openProject(). |
|
Definition at line 64 of file genericproject_part.h. Referenced by openProject(). |
|
Definition at line 80 of file genericproject_part.h. Referenced by allFiles(). |
|
Definition at line 79 of file genericproject_part.h. Referenced by loadProjectConfig(). |
|
Definition at line 83 of file genericproject_part.h. Referenced by addFiles(), allFiles(), and openProject(). |
|
Definition at line 84 of file genericproject_part.h. Referenced by openProject(). |
|
Definition at line 86 of file genericproject_part.h. |
|
Definition at line 78 of file genericproject_part.h. Referenced by addFilePrivate(), addFiles(), createGroupItem(), and ~GenericProjectPart(). |
The documentation for this class was generated from the following files:
- buildtools/generic/genericproject_part.h
- buildtools/generic/genericproject_part.cpp