#include <kdevproject.h>

Public Types | |
enum | Options { UsesOtherBuildSystem = 0, UsesAutotoolsBuildSystem = 1, UsesTQMakeBuildSystem =2 } |
Signals | |
void | addedFilesToProject (const TQStringList &fileList) |
void | removedFilesFromProject (const TQStringList &fileList) |
void | changedFilesInProject (const TQStringList &fileList) |
void | projectCompiled () |
void | activeDirectoryChanged (const TQString &olddir, const TQString &newdir) |
Public Member Functions | |
KDevProject (const KDevPluginInfo *info, TQObject *parent=0, const char *name=0) | |
virtual | ~KDevProject () |
virtual void | openProject (const TQString &dirName, const TQString &projectName) |
virtual void | closeProject ()=0 |
virtual Options | options () const |
virtual TQString | projectDirectory () const =0 |
virtual TQString | projectName () const =0 |
virtual DomUtil::PairList | runEnvironmentVars () const =0 |
virtual TQString | mainProgram () const =0 |
virtual TQString | runDirectory () const =0 |
virtual TQString | runArguments () const =0 |
virtual TQString | debugArguments () const =0 |
virtual TQString | activeDirectory () const =0 |
virtual TQString | buildDirectory () const =0 |
virtual TQStringList | allFiles () const =0 |
virtual TQStringList | distFiles () const =0 |
virtual void | addFiles (const TQStringList &fileList)=0 |
virtual void | addFile (const TQString &fileName)=0 |
virtual void | removeFiles (const TQStringList &fileList)=0 |
virtual void | removeFile (const TQString &fileName)=0 |
virtual void | changedFiles (const TQStringList &fileList) |
virtual void | changedFile (const TQString &fileName) |
virtual bool | isProjectFile (const TQString &absFileName) |
virtual TQString | relativeProjectFile (const TQString &absFileName) |
virtual TQStringList | symlinkProjectFiles () |
![]() | |
KDevPlugin (const KDevPluginInfo *info, TQObject *parent, const char *name=0) | |
virtual | ~KDevPlugin () |
const KDevPluginInfo * | info () |
KDevMainWindow * | mainWindow () |
KDevCore * | core () const |
KDevProject * | project () const |
KDevLanguageSupport * | languageSupport () const |
CodeModel * | codeModel () const |
TQDomDocument * | projectDom () const |
KDevPartController * | partController () const |
virtual KDevPluginController * | pluginController () const |
KDevCodeRepository * | codeRepository () const |
template<class Extension > | |
Extension * | extension (const TQString &serviceType, const TQString &constraint="") |
virtual void | restorePartialProjectSession (const TQDomElement *el) |
virtual void | savePartialProjectSession (TQDomElement *el) |
Protected Member Functions | |
TQString | defaultRunDirectory (const TQString &projectPluginName) const |
Detailed Description
KDevelop project interface.
Plugins implementing the KDevProject interfaces are used to manage projects.
Project can be considered as a way of grouping files (in text editors) or as a way of providing support for a build system (like it is done in TDevelop IDE buildtools).
Definition at line 48 of file kdevproject.h.
Member Enumeration Documentation
◆ Options
enum KDevProject::Options |
Options of the project plugin.
Definition at line 67 of file kdevproject.h.
Constructor & Destructor Documentation
◆ KDevProject()
KDevProject::KDevProject | ( | const KDevPluginInfo * | info, |
TQObject * | parent = 0 , |
||
const char * | name = 0 |
||
) |
Constructs a project plugin.
- Parameters
-
info Important information about the plugin - plugin internal and generic (GUI) name, description, a list of authors, etc. That information is used to show plugin information in various places like "about application" dialog, plugin selector dialog, etc. Plugin does not take ownership on info object, also its lifetime should be equal to the lifetime of the plugin. parent The parent object for the plugin. Parent object must implement KDevApi interface. Otherwise the plugin will not be constructed. name The internal name which identifies the plugin.
Definition at line 40 of file kdevproject.cpp.
◆ ~KDevProject()
|
virtual |
Destructor.
Definition at line 54 of file kdevproject.cpp.
Member Function Documentation
◆ activeDirectory()
|
pure virtual |
Returns the path (relative to the project directory) of the active directory.
All newly automatically generated classes and files are usually added here.
◆ activeDirectoryChanged
|
signal |
Emitted when the active directory of the project changes.
- Parameters
-
olddir The old active directory newdir The new active directory
◆ addedFilesToProject
|
signal |
Emitted when a new list of files has been added to the project.
Provided for convenience when many files were added.
- Parameters
-
fileList The file names relative to the project directory.
◆ addFile()
|
pure virtual |
Adds a file to the project.
- Parameters
-
fileName The file name relative to the project directory.
◆ addFiles()
|
pure virtual |
Adds a list of files to the project.
Provided for convenience when adding many files.
- Parameters
-
fileList The list of file names relative to the project directory.
◆ allFiles()
|
pure virtual |
- Returns
- The list of all files in the project. The names are relative to the project directory.
◆ buildDirectory()
|
pure virtual |
- Returns
- The canonical build directory of the project. If the separate build directory is not supported, this should return the same as projectDiretory(). Canonical means that a path does not contain symbolic links or redundant "." or ".." elements.
◆ changedFile()
|
virtual |
Notifies the project of a change to one of the files.
- Parameters
-
fileName The file name relative to the project directory.
Definition at line 62 of file kdevproject.cpp.
◆ changedFiles()
|
virtual |
Notifies the project about changes to the files.
Provided for convenience when changing many files.
- Parameters
-
fileList The list of file names relative to the project directory..
Definition at line 71 of file kdevproject.cpp.
◆ changedFilesInProject
|
signal |
Emitted when a list of files has changed in the project.
- Parameters
-
fileList The file names relative to the project directory.
◆ closeProject()
|
pure virtual |
This method is invoked when the project is about to be closed.
◆ debugArguments()
|
pure virtual |
The command line arguments that the mainProgram() should be debugged with.
◆ defaultRunDirectory()
|
protected |
Default implementation of runDirectory method.
Uses 'projectPluginName' to obtain configuration from project DOM and returns:
if /<projectPluginName>/run/directoryradio == executable The directory where the executable is. if /<projectPluginName>/run/directoryradio == build The build directory. if /kdevautoproject/run/directoryradio == custom The custom directory absolute path. Derived classes are supposed to explicitly call this implementation
Definition at line 128 of file kdevproject.cpp.
◆ distFiles()
|
pure virtual |
- Returns
- The list of files that are part of the distribution but not under project control. Used mainly to package and publish extra files among with the project.
◆ isProjectFile()
|
virtual |
- Returns
- true if the file
absFileName
is a part of the project.
- Parameters
-
absFileName Absolute name of a file to check.
Definition at line 81 of file kdevproject.cpp.
◆ mainProgram()
|
pure virtual |
- Returns
- The path to main binary program of the project.
- Parameters
-
relative if true then the path returned is relative to the project directory.
◆ openProject()
|
virtual |
This method is invoked when the project is opened (i.e.
actually just after this class has been instantiated).
- Parameters
-
dirName The project directory, which should afterwards be returned by the projectDirectory() method. projectName The project name, which is equivalent to the project file name without the suffix.
Definition at line 118 of file kdevproject.cpp.
◆ options()
|
virtual |
Reimplement this method to set project plugin options.
Default implementation returns KDevProject::UsesOtherBuildSystem.
Definition at line 76 of file kdevproject.cpp.
◆ projectCompiled
|
signal |
Emitted when one compile related command (make, make install, make ...) ends sucessfuly.
Used to reparse the files after a sucessful compilation.
◆ projectDirectory()
|
pure virtual |
- Returns
- The canonical absolute directory of the project. Canonical means that a path does not contain symbolic links or redundant "." or ".." elements.
◆ projectName()
|
pure virtual |
Returns the name of the project.
◆ relativeProjectFile()
|
virtual |
- Returns
- The path (relative to the project directory) of the file
absFileName
.
- Parameters
-
absFileName Absolute name of a file.
Definition at line 86 of file kdevproject.cpp.
◆ removedFilesFromProject
|
signal |
Emitted when a list of files has been removed from the project.
Provided for convenience when many files were removed.
- Parameters
-
fileList The file names relative to the project directory.
◆ removeFile()
|
pure virtual |
Removes a file from the project.
- Parameters
-
fileName The file name relative to the project directory.
◆ removeFiles()
|
pure virtual |
Removes a list of files from the project.
Provided for convenience when removing many files.
- Parameters
-
fileList The list of file names relative to the project directory.
◆ runArguments()
|
pure virtual |
The command line arguments that the mainProgram() should be run with.
◆ runDirectory()
|
pure virtual |
Absolute path (directory) from where the mainProgram() should be run.
◆ runEnvironmentVars()
|
pure virtual |
- Returns
- The environment variables that sould be set before running mainProgram().
◆ symlinkProjectFiles()
|
virtual |
- Returns
- The list of files known to the project through symlinks.
Definition at line 123 of file kdevproject.cpp.
The documentation for this class was generated from the following files: