KDE 4.2 API Reference shell
KDevelop::Project Class Reference
#include <project.h>
Inherits IProject.
Detailed Description
Object which represents a KDevelop project.Provide better descriptions
Definition at line 53 of file project.h.
Public Slots | |
| IBuildSystemManager * | buildSystemManager () const |
| virtual Q_SCRIPTABLE void | close () |
| virtual Q_SCRIPTABLE const KUrl | folder () const |
| bool | inProject (const KUrl &url) const |
| IPlugin * | managerPlugin () const |
| virtual Q_SCRIPTABLE QString | name () const |
| virtual Q_SCRIPTABLE bool | open (const KUrl &projectFileUrl) |
| IProjectFileManager * | projectFileManager () const |
| ProjectFolderItem * | projectItem () const |
| KUrl | relativeUrl (const KUrl &absoluteUrl) const |
| void | setManagerPlugin (IPlugin *manager) |
| KUrl | urlRelativeToProject (const KUrl &relativeUrl) const |
| IPlugin * | versionControlPlugin () const |
Public Member Functions | |
| virtual void | addToFileSet (const IndexedString &) |
| KUrl | developerFileUrl () const |
| QString | developerTempFile () const |
| virtual ProjectFileItem * | fileAt (int i) const |
| virtual int | fileCount () const |
| virtual QList< ProjectFileItem * > | files () const |
| virtual QSet< IndexedString > | fileSet () const |
| virtual QList< ProjectFileItem * > | filesForUrl (const KUrl &) const |
| Project (QObject *parent=0) | |
| virtual KSharedConfig::Ptr | projectConfiguration () const |
| virtual KUrl | projectFileUrl () const |
| QString | projectTempFile () const |
| virtual void | reloadModel () |
| virtual void | removeFromFileSet (const IndexedString &) |
| virtual | ~Project () |
Constructor & Destructor Documentation
| KDevelop::Project::Project | ( | QObject * | parent = 0 |
) |
Constructs a project.
- Parameters:
-
parent The parent object for the plugin.
Definition at line 166 of file project.cpp.
| KDevelop::Project::~Project | ( | ) | [virtual] |
Member Function Documentation
| IBuildSystemManager * KDevelop::Project::buildSystemManager | ( | ) | const [slot] |
Get the build system manager for the project.
- Returns:
- the build system manager for the project, if one exists; otherwise null
Definition at line 462 of file project.cpp.
| void KDevelop::Project::close | ( | ) | [virtual, slot] |
This method is invoked when the project needs to be closed.
Definition at line 368 of file project.cpp.
| int KDevelop::Project::fileCount | ( | ) | const [virtual] |
| const KUrl KDevelop::Project::folder | ( | ) | const [virtual, slot] |
Get the project folder.
- Returns:
- The canonical absolute directory of the project.
Definition at line 215 of file project.cpp.
| bool KDevelop::Project::inProject | ( | const KUrl & | url | ) | const [slot] |
Check if the url specified by url is part of the project.
url can be either a relative url (to the project directory) or an absolute url.
- Parameters:
-
url the url to check
- Returns:
- true if the url url is a part of the project.
Definition at line 398 of file project.cpp.
| IPlugin * KDevelop::Project::managerPlugin | ( | ) | const [slot] |
Get the plugin that manages the project This can be used to get other interfaces like IBuildSystemManager.
Definition at line 467 of file project.cpp.
| QString KDevelop::Project::name | ( | ) | const [virtual, slot] |
| bool KDevelop::Project::open | ( | const KUrl & | projectFileUrl | ) | [virtual, slot] |
Open a project This method opens a project and starts the process of loading the data for the project from disk.
- Parameters:
-
projectFileUrl The url pointing to the location of the project file to load The project name is taken from the Name key in the project file in the 'General' group
Definition at line 241 of file project.cpp.
| IProjectFileManager * KDevelop::Project::projectFileManager | ( | ) | const [slot] |
Get the file manager for the project.
- Returns:
- the file manager for the project, if one exists; otherwise null
Definition at line 457 of file project.cpp.
| ProjectFolderItem * KDevelop::Project::projectItem | ( | ) | const [slot] |
| KUrl KDevelop::Project::relativeUrl | ( | const KUrl & | absoluteUrl | ) | const [slot] |
Find the url relative to the project directory equivalent to absoluteUrl.
This function does not check to see if the file is contained within the project; for that, use inProject().
- Parameters:
-
absoluteUrl Absolute url to convert
- Deprecated:
- use KUrl::relativeUrl instead
- Returns:
- absoluteUrl relative to projectDirectory()
Definition at line 443 of file project.cpp.
| void KDevelop::Project::setManagerPlugin | ( | IPlugin * | manager | ) | [slot] |
| KUrl KDevelop::Project::urlRelativeToProject | ( | const KUrl & | relativeUrl | ) | const [slot] |
Returns the absolute url corresponding to the given relativeUrl and the project directory.
- Parameters:
-
relativeUrl Relative url to convert
- Returns:
- the absolute URL relative to projectDirectory()
Definition at line 449 of file project.cpp.
The documentation for this class was generated from the following files:
