KDevProject Class Reference
#include <kdevproject.h>
Inheritance diagram for KDevProject:


Public Types | |
enum | Options { UsesAutotoolsBuildSystem = 1, UsesQMakeBuildSystem } |
Signals | |
void | addedFilesToProject (const QStringList &fileList) |
Emitted when a new list of files has been added to the project. | |
void | removedFilesFromProject (const QStringList &fileList) |
Emitted when a list of files has been removed from the project. | |
void | changedFilesInProject (const QStringList &fileList) |
Emitted when a list of files has changed in the project. | |
void | projectCompiled () |
Emitted when one compile related command (make, make install, make ...) ends sucessfuly. | |
Public Member Functions | |
KDevProject (const QString &pluginName, const QString &icon, QObject *parent=0, const char *name=0) | |
virtual | ~KDevProject () |
virtual void | openProject (const QString &dirName, const QString &projectName) |
This method is invoked when the project is opened (i.e. | |
virtual void | closeProject ()=0 |
This method is invoked when the project is about to be closed. | |
virtual Options | options () const |
virtual QString | projectDirectory () const =0 |
Returns the canonical toplevel directory of the project. | |
virtual QString | projectName () const =0 |
Returns the name of the project. | |
virtual DomUtil::PairList | runEnvironmentVars () const =0 |
The environment variables that sould be set before running mainProgram(). | |
virtual QString | mainProgram (bool relative=false) const =0 |
Returns the absolute path to main binary program of the project. | |
virtual QString | runDirectory () const =0 |
Absolute path (directory) from where the mainProgram() should be run. | |
virtual QString | runArguments () const =0 |
The command line arguments that the mainProgram() should be run with. | |
virtual QString | activeDirectory () const =0 |
Returns the path (relative to the project directory) of the active directory. | |
virtual QString | buildDirectory () const =0 |
Returns the canonical build directory of the project. | |
virtual QStringList | allFiles () const =0 |
Returns a list of all files in the project. | |
virtual QStringList | distFiles () const =0 |
Returns a list of files that are part of the distribution but not under project control. | |
virtual void | addFiles (const QStringList &fileList)=0 |
Adds a list of files to the project. | |
virtual void | addFile (const QString &fileName)=0 |
Adds a file to the project. | |
virtual void | removeFiles (const QStringList &fileList)=0 |
Removes a list of files from the project. | |
virtual void | removeFile (const QString &fileName)=0 |
Removes a file from the project. | |
virtual void | changedFiles (const QStringList &fileList) |
Notifies the project of changes to the files. | |
virtual void | changedFile (const QString &fileName) |
Notifies the project of a change to one of the files. | |
virtual bool | isProjectFile (const QString &absFileName) |
Returns true if the file absFileName is part of the project. | |
virtual QString | relativeProjectFile (const QString &absFileName) |
Returns the path (relative to the project directory) of the file absFileName. | |
virtual QStringList | symlinkProjectFiles () |
Private Slots | |
void | slotBuildFileMap () |
void | slotAddFilesToFileMap (const QStringList &fileList) |
void | slotRemoveFilesFromFileMap (const QStringList &fileList) |
Private Attributes | |
QMap< QString, QString > | m_absToRel |
QStringList | m_symlinkList |
Member Enumeration Documentation
|
Definition at line 43 of file kdevproject.h. Referenced by options(). |
Constructor & Destructor Documentation
|
Definition at line 31 of file kdevproject.cpp. References addedFilesToProject(), removedFilesFromProject(), slotAddFilesToFileMap(), and slotRemoveFilesFromFileMap(). |
|
Definition at line 43 of file kdevproject.cpp. |
Member Function Documentation
|
Returns the path (relative to the project directory) of the active directory. All newly generated classes are added here. Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by ScriptNewFileDialog::accept(), ImplementationWidget::createClass(), FileCreatePart::createNewFile(), CppNewClassDialog::ClassGenerator::gen_interface(), CppNewClassDialog::ClassGenerator::generate(), MakeWidget::guessFileName(), and ReplaceWidget::showDialog(). |
|
Emitted when a new list of files has been added to the project. Provided for convenience when many files were added. The file names are relative to the project directory. Referenced by ScriptProjectPart::addFiles(), GenericProjectPart::addFiles(), CustomProjectPart::addFiles(), AntProjectPart::addFiles(), TrollProjectWidget::emitAddedFile(), AutoProjectWidget::emitAddedFile(), AutoProjectWidget::emitAddedFiles(), KDevProject(), and TrollProjectWidget::slotDetailsContextMenu(). |
|
Adds a file to the project. The given file name must be relative to the project directory. Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by FileCreatePart::createNewFile(), and CppSupportPart::slotExtractInterface(). |
|
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. Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by ImplementationWidget::createClass(), and CppNewClassDialog::ClassGenerator::gen_interface(). |
|
|
Returns the canonical build directory of the project. If the separate build directory is not supported, this should return the same as projectDiretory(). Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by GDBDebugger::DebuggerConfigWidget::DebuggerConfigWidget(), MakeWidget::guessFileName(), and GDBDebugger::DebuggerPart::startDebugger(). |
|
Notifies the project of a change to one of the files. The given file name must be relative to the project directory. Reimplemented in AdaProjectPart, HaskellProjectPart, and PascalProjectPart. Definition at line 47 of file kdevproject.cpp. References changedFilesInProject(). Referenced by PascalProjectPart::changedFile(), HaskellProjectPart::changedFile(), and AdaProjectPart::changedFile(). |
|
Notifies the project of changes to the files. Provided for convenience when changing many files. The given file names must be relative to the project directory. Reimplemented in AdaProjectPart, HaskellProjectPart, and PascalProjectPart. Definition at line 56 of file kdevproject.cpp. References changedFilesInProject(). Referenced by PascalProjectPart::changedFiles(), HaskellProjectPart::changedFiles(), AdaProjectPart::changedFiles(), and ReplaceWidget::makeReplacements(). |
|
Emitted when a list of files has changed in the project. The file names are relative to the project directory. Referenced by changedFile(), and changedFiles(). |
|
This method is invoked when the project is about to be closed.
Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by ProjectManager::unloadProjectPart(). |
|
Returns a list of files that are part of the distribution but not under project control.
Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by DistpartDialog::loadSettings(), and DistpartDialog::slotcreateSrcArchPushButtonPressed(). |
|
Returns true if the file absFileName is part of the project.
Definition at line 66 of file kdevproject.cpp. References m_absToRel. Referenced by TrollProjectPart::addFiles(), CustomProjectPart::contextMenu(), ClassViewWidget::insertFile(), CppSupportPart::isValidSource(), relativeProjectFile(), and ClassViewWidget::removeFile(). |
|
Returns the absolute path to main binary program of the project.
Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by GDBDebugger::DebuggerPart::slotDCOPApplicationRegistered(), PythonSupportPart::slotExecute(), PerlSupportPart::slotExecute(), and GDBDebugger::DebuggerPart::startDebugger(). |
|
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 in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Definition at line 97 of file kdevproject.cpp. References slotBuildFileMap(). Referenced by ProjectManager::loadProjectPart(), ScriptProjectPart::openProject(), TrollProjectPart::openProject(), PascalProjectPart::openProject(), GenericProjectPart::openProject(), CustomProjectPart::openProject(), AutoProjectPart::openProject(), AntProjectPart::openProject(), and AdaProjectPart::openProject(). |
|
Reimplemented in AutoProjectPart, and TrollProjectPart. Definition at line 61 of file kdevproject.cpp. References Options. Referenced by SubclassingDlg::accept(), ImplementationWidget::createClass(), and CppNewClassDialog::ClassGenerator::gen_implementation(). |
|
Emitted when one compile related command (make, make install, make ...) ends sucessfuly. Used to reparse the files after a sucessful compilation Referenced by TrollProjectPart::slotCommandFinished(), CustomProjectPart::slotCommandFinished(), and AutoProjectPart::slotCommandFinished(). |
|
|
|
Returns the path (relative to the project directory) of the file absFileName.
Definition at line 71 of file kdevproject.cpp. References isProjectFile(), and m_absToRel. Referenced by ClassViewWidget::insertFile(), and ClassViewWidget::removeFile(). |
|
Emitted when a list of files has been removed from the project. Provided for convenience when many files were removed. The file names are relative to the project directory. Referenced by TrollProjectWidget::emitRemovedFile(), AutoProjectWidget::emitRemovedFile(), AutoProjectWidget::emitRemovedFiles(), KDevProject(), ScriptProjectPart::removeFiles(), TrollProjectPart::removeFiles(), CustomProjectPart::removeFiles(), AutoProjectPart::removeFiles(), and AntProjectPart::removeFiles(). |
|
Removes a file from the project. The given file name must be relative to the project directory. Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. |
|
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. Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. |
|
The command line arguments that the mainProgram() should be run with.
Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by GDBDebugger::DebuggerPart::startDebugger(). |
|
Absolute path (directory) from where the mainProgram() should be run.
Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by GDBDebugger::DebuggerPart::startDebugger(). |
|
The environment variables that sould be set before running mainProgram().
Implemented in AdaProjectPart, AntProjectPart, AutoProjectPart, CustomProjectPart, GenericProjectPart, HaskellProjectPart, PascalProjectPart, TrollProjectPart, and ScriptProjectPart. Referenced by GDBDebugger::DebuggerPart::startDebugger(). |
|
Definition at line 107 of file kdevproject.cpp. References URLUtil::canonicalPath(), m_absToRel, m_symlinkList, and projectDirectory(). Referenced by KDevProject(). |
|
Definition at line 78 of file kdevproject.cpp. References allFiles(), URLUtil::canonicalPath(), k_funcinfo, kdDebug(), m_absToRel, m_symlinkList, and projectDirectory(). Referenced by openProject(). |
|
Definition at line 124 of file kdevproject.cpp. References m_absToRel, m_symlinkList, and projectDirectory(). Referenced by KDevProject(). |
|
Definition at line 102 of file kdevproject.cpp. Referenced by MakeWidget::guessFileName(). |
Member Data Documentation
|
Definition at line 195 of file kdevproject.h. Referenced by isProjectFile(), relativeProjectFile(), slotAddFilesToFileMap(), slotBuildFileMap(), and slotRemoveFilesFromFileMap(). |
|
Definition at line 196 of file kdevproject.h. Referenced by slotAddFilesToFileMap(), slotBuildFileMap(), and slotRemoveFilesFromFileMap(). |
The documentation for this class was generated from the following files:
- lib/interfaces/kdevproject.h
- lib/interfaces/kdevproject.cpp