ScriptProjectPart Class Reference
This is the script build tool part Put a more detailed description of your part in these lines. More...
#include <scriptprojectpart.h>
Inheritance diagram for ScriptProjectPart:


Public Member Functions | |
ScriptProjectPart (QObject *parent, const char *name, const QStringList &args) | |
~ScriptProjectPart () | |
QStringList | distFiles () const |
Returns a list of files that are part of the distribution but not under project control. | |
Protected Member Functions | |
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 QString | mainProgram (bool relative=false) const |
Retuns the currently selected main program The returned string can be: if run/directoryradio == executable The executable name if run/directoryradio == build The path to executable relative to build directory if run/directoryradio == custom or relative == false The absolute path to executable. | |
virtual QString | activeDirectory () const |
Returns the path (relative to the project directory) of the active directory. | |
virtual QStringList | allFiles () const |
Returns a list of all files in the project. | |
virtual void | addFile (const QString &fileName) |
Adds a file to the project. | |
virtual void | addFiles (const QStringList &fileList) |
Adds a list of files to the project. | |
virtual void | removeFile (const QString &fileName) |
Removes a file from the project. | |
virtual void | removeFiles (const QStringList &fileList) |
Removes a list of files from the project. | |
virtual QString | buildDirectory () const |
Returns the canonical build directory of the project. | |
virtual QString | runDirectory () const |
Retuns the currently selected run directory The returned string can be: if run/directoryradio == executable The directory where the executable is if run/directoryradio == build The directory where the executable is relative to build directory if run/directoryradio == custom The custom directory absolute path. | |
virtual QString | runArguments () const |
Retuns a QString with the run command line arguments. | |
virtual DomUtil::PairList | runEnvironmentVars () const |
Retuns a PairList with the run environment variables. | |
Private Slots | |
void | projectConfigWidget (KDialogBase *dlg) |
void | slotNewFile () |
Private Attributes | |
QString | m_projectDirectory |
QString | m_projectName |
QStringList | m_sourceFiles |
Friends | |
class | ScriptNewFileDialog |
Detailed Description
This is the script 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.
- Unmaintained:
- This part is currently un-maintained
- Deprecated:
- This class is deprecated, use GenericProjectPart (buildtools/generic) instead.
- 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 26 of file scriptprojectpart.h.
Constructor & Destructor Documentation
|
|
|
Definition at line 63 of file scriptprojectpart.cpp. |
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 269 of file scriptprojectpart.cpp. References KDevPlugin::projectDom(), and DomUtil::readEntry(). |
|
Adds a file to the project. The given file name must be relative to the project directory. Implements KDevProject. Definition at line 291 of file scriptprojectpart.cpp. References addFiles(), and kdDebug(). Referenced by ScriptNewFileDialog::accept(). |
|
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 301 of file scriptprojectpart.cpp. References KDevProject::addedFilesToProject(), and m_sourceFiles. Referenced by addFile(), and removeFile(). |
|
Returns a list of all files in the project. The files are relative to the project directory. Implements KDevProject. Definition at line 277 of file scriptprojectpart.cpp. Referenced by 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 180 of file scriptprojectpart.cpp. Referenced by mainProgram(), and runDirectory(). |
|
This method is invoked when the project is about to be closed.
Implements KDevProject. Definition at line 169 of file scriptprojectpart.cpp. |
|
Returns a list of files that are part of the distribution but not under project control.
Implements KDevProject. Definition at line 345 of file scriptprojectpart.cpp. References allFiles(), and projectDirectory(). |
|
Retuns the currently selected main program The returned string can be: if run/directoryradio == executable The executable name if run/directoryradio == build The path to executable relative to build directory if run/directoryradio == custom or relative == false The absolute path to executable.
Implements KDevProject. Definition at line 238 of file scriptprojectpart.cpp. References buildDirectory(), KDevPlugin::projectDom(), and DomUtil::readEntry(). |
|
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 93 of file scriptprojectpart.cpp. References kdDebug(), KDevPlugin::languageSupport(), KMimeType::List, m_projectDirectory, m_projectName, m_sourceFiles, matchesPattern(), KDevLanguageSupport::mimeTypes(), KDevProject::openProject(), KDevPlugin::projectDom(), DomUtil::readEntry(), and DomUtil::writeEntry(). |
|
Definition at line 67 of file scriptprojectpart.cpp. References KDialogBase::addVBoxPage(). |
|
Returns the canonical toplevel directory of the project.
Implements KDevProject. Definition at line 174 of file scriptprojectpart.cpp. Referenced by distFiles(). |
|
Returns the name of the project.
Implements KDevProject. Definition at line 185 of file scriptprojectpart.cpp. |
|
Removes a file from the project. The given file name must be relative to the project directory. Implements KDevProject. Definition at line 313 of file scriptprojectpart.cpp. References addFiles(). |
|
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 321 of file scriptprojectpart.cpp. References m_sourceFiles, and KDevProject::removedFilesFromProject(). |
|
Retuns a QString with the run command line arguments.
Implements KDevProject. Definition at line 263 of file scriptprojectpart.cpp. References KDevPlugin::projectDom(), and DomUtil::readEntry(). |
|
Retuns the currently selected run directory The returned string can be: if run/directoryradio == executable The directory where the executable is if run/directoryradio == build The directory where the executable is relative to build directory if run/directoryradio == custom The custom directory absolute path.
Implements KDevProject. Definition at line 207 of file scriptprojectpart.cpp. References buildDirectory(), KDevPlugin::projectDom(), and DomUtil::readEntry(). |
|
Retuns a PairList with the run environment variables.
Implements KDevProject. Definition at line 192 of file scriptprojectpart.cpp. References DomUtil::PairList, KDevPlugin::projectDom(), and DomUtil::readPairListEntry(). |
|
Definition at line 333 of file scriptprojectpart.cpp. |
Friends And Related Function Documentation
|
Definition at line 62 of file scriptprojectpart.h. |
Member Data Documentation
|
Definition at line 58 of file scriptprojectpart.h. Referenced by openProject(). |
|
Definition at line 59 of file scriptprojectpart.h. Referenced by openProject(). |
|
Definition at line 60 of file scriptprojectpart.h. Referenced by addFiles(), openProject(), and removeFiles(). |
The documentation for this class was generated from the following files:
- buildtools/script/scriptprojectpart.h
- buildtools/script/scriptprojectpart.cpp