KDE 4.2 API Reference interfaces
KDevelop::IProject Class Reference
#include <iproject.h>
Detailed Description
Object which represents a KDevelop project.Provide better descriptions
Definition at line 56 of file iproject.h.
Public Slots | |
| virtual Q_SCRIPTABLE void | close ()=0 |
| virtual Q_SCRIPTABLE const KUrl | folder () const =0 |
| virtual bool | inProject (const KUrl &url) const =0 |
| virtual Q_SCRIPTABLE QString | name () const =0 |
| virtual Q_SCRIPTABLE bool | open (const KUrl &projectFileUrl)=0 |
| virtual KUrl | relativeUrl (const KUrl &absoluteUrl) const =0 |
| virtual KUrl | urlRelativeToProject (const KUrl &relativeUrl) const =0 |
Public Member Functions | |
| virtual void | addToFileSet (const IndexedString &)=0 |
| virtual Q_SCRIPTABLE IBuildSystemManager * | buildSystemManager () const =0 |
| virtual Q_SCRIPTABLE ProjectFileItem * | fileAt (int pos) const =0 |
| virtual Q_SCRIPTABLE int | fileCount () const =0 |
| virtual Q_SCRIPTABLE QList < ProjectFileItem * > | files () const =0 |
| virtual QSet< IndexedString > | fileSet () const =0 |
| virtual Q_SCRIPTABLE QList < ProjectFileItem * > | filesForUrl (const KUrl &file) const =0 |
| IProject (QObject *parent=0) | |
| virtual Q_SCRIPTABLE IPlugin * | managerPlugin () const =0 |
| virtual KSharedConfig::Ptr | projectConfiguration () const =0 |
| virtual Q_SCRIPTABLE IProjectFileManager * | projectFileManager () const =0 |
| virtual Q_SCRIPTABLE KUrl | projectFileUrl () const =0 |
| virtual Q_SCRIPTABLE ProjectFolderItem * | projectItem () const =0 |
| virtual Q_SCRIPTABLE void | reloadModel ()=0 |
| virtual void | removeFromFileSet (const IndexedString &)=0 |
| virtual Q_SCRIPTABLE IPlugin * | versionControlPlugin () const =0 |
| virtual | ~IProject () |
Constructor & Destructor Documentation
| KDevelop::IProject::IProject | ( | QObject * | parent = 0 |
) |
Constructs a project.
- Parameters:
-
parent The parent object for the plugin.
Definition at line 34 of file iproject.cpp.
| KDevelop::IProject::~IProject | ( | ) | [virtual] |
Member Function Documentation
| virtual Q_SCRIPTABLE IBuildSystemManager* KDevelop::IProject::buildSystemManager | ( | ) | const [pure virtual] |
Get the build system manager for the project.
- Returns:
- the build system manager for the project, if one exists; otherwise null
| virtual Q_SCRIPTABLE void KDevelop::IProject::close | ( | ) | [pure virtual, slot] |
This method is invoked when the project needs to be closed.
| virtual Q_SCRIPTABLE ProjectFileItem* KDevelop::IProject::fileAt | ( | int | pos | ) | const [pure virtual] |
Get the item corresponding to the pos file.
| virtual Q_SCRIPTABLE int KDevelop::IProject::fileCount | ( | ) | const [pure virtual] |
Get how much files are there in the project.
| virtual Q_SCRIPTABLE QList<ProjectFileItem*> KDevelop::IProject::files | ( | ) | const [pure virtual] |
Get a list of all files in the project.
| virtual Q_SCRIPTABLE QList<ProjectFileItem*> KDevelop::IProject::filesForUrl | ( | const KUrl & | file | ) | const [pure virtual] |
Get all items corresponding to the file url.
| virtual Q_SCRIPTABLE const KUrl KDevelop::IProject::folder | ( | ) | const [pure virtual, slot] |
Get the project folder.
- Returns:
- The canonical absolute directory of the project.
| virtual bool KDevelop::IProject::inProject | ( | const KUrl & | url | ) | const [pure virtual, 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.
| virtual Q_SCRIPTABLE IPlugin* KDevelop::IProject::managerPlugin | ( | ) | const [pure virtual] |
Get the plugin that manages the project This can be used to get other interfaces like IBuildSystemManager.
| virtual Q_SCRIPTABLE QString KDevelop::IProject::name | ( | ) | const [pure virtual, slot] |
Returns the name of the project.
| virtual Q_SCRIPTABLE bool KDevelop::IProject::open | ( | const KUrl & | projectFileUrl | ) | [pure 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
| virtual Q_SCRIPTABLE IProjectFileManager* KDevelop::IProject::projectFileManager | ( | ) | const [pure virtual] |
Get the file manager for the project.
- Returns:
- the file manager for the project, if one exists; otherwise null
| virtual Q_SCRIPTABLE KUrl KDevelop::IProject::projectFileUrl | ( | ) | const [pure virtual] |
Get the url of the project file.
| virtual Q_SCRIPTABLE ProjectFolderItem* KDevelop::IProject::projectItem | ( | ) | const [pure virtual] |
With this the top-level project item can be retrieved.
| virtual KUrl KDevelop::IProject::relativeUrl | ( | const KUrl & | absoluteUrl | ) | const [pure virtual, 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()
| virtual Q_SCRIPTABLE void KDevelop::IProject::reloadModel | ( | ) | [pure virtual] |
Make the model to reload.
| virtual KUrl KDevelop::IProject::urlRelativeToProject | ( | const KUrl & | relativeUrl | ) | const [pure virtual, 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()
| virtual Q_SCRIPTABLE IPlugin* KDevelop::IProject::versionControlPlugin | ( | ) | const [pure virtual] |
Get the version control plugin for this project This may return 0 if the project is not under version control or version control has been disabled for this project.
The documentation for this class was generated from the following files:
