#include <iproject.h>

Inheritance diagram for KDevelop::IProject:

Public Slots
virtual void	close ()=0

virtual void	reloadModel ()=0

Signals
void	fileAddedToSet (KDevelop::ProjectFileItem *item)

void	fileRemovedFromSet (KDevelop::ProjectFileItem *item)

Public Member Functions
	IProject (QObject *parent=nullptr)

	~IProject () override

virtual void	addToFileSet (ProjectFileItem *item)=0

virtual IBuildSystemManager *	buildSystemManager () const =0

virtual QSet< IndexedString >	fileSet () const =0

virtual QList< ProjectFileItem * >	filesForPath (const IndexedString &file) const =0

virtual QList< ProjectFolderItem * >	foldersForPath (const IndexedString &folder) const =0

virtual bool	inProject (const IndexedString &path) const =0

virtual bool	isReady () const =0

virtual QList< ProjectBaseItem * >	itemsForPath (const IndexedString &path) const =0

virtual IPlugin *	managerPlugin () const =0

virtual Q_SCRIPTABLE QString	name () const =0

virtual Path	path () const =0

virtual KSharedConfigPtr	projectConfiguration () const =0

virtual Path	projectFile () const =0

virtual IProjectFileManager *	projectFileManager () const =0

virtual ProjectFolderItem *	projectItem () const =0

virtual void	removeFromFileSet (ProjectFileItem *item)=0

virtual void	setReloadJob (KJob *job)=0

virtual IPlugin *	versionControlPlugin () const =0

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method)

bool	disconnect (const QObject receiver, const char method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Properties
QString	projectName

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Detailed Description

Object which represents a KDevelop project.

Provide better descriptions

Definition at line 59 of file iproject.h.

Constructor & Destructor Documentation

◆ IProject()

KDevelop::IProject::IProject ( QObject * parent = nullptr )

explicit

Constructs a project.

Parameters

parent The parent object for the plugin.

Definition at line 34 of file iproject.cpp.

◆ ~IProject()

KDevelop::IProject::~IProject ( )

override

Destructor.

Definition at line 39 of file iproject.cpp.

Member Function Documentation

◆ addToFileSet()

virtual void KDevelop::IProject::addToFileSet ( ProjectFileItem * item )

pure virtual

◆ buildSystemManager()

virtual 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

◆ close

virtual void KDevelop::IProject::close ( )

pure virtualslot

This method is invoked when the project needs to be closed.

◆ fileAddedToSet

void KDevelop::IProject::fileAddedToSet ( KDevelop::ProjectFileItem * item )

signal

Gets emitted whenever a file was added to the project.

◆ fileRemovedFromSet

void KDevelop::IProject::fileRemovedFromSet ( KDevelop::ProjectFileItem * item )

signal

Gets emitted whenever a file was removed from the project.

◆ fileSet()

virtual QSet<IndexedString> KDevelop::IProject::fileSet ( ) const

pure virtual

◆ filesForPath()

virtual QList<ProjectFileItem*> KDevelop::IProject::filesForPath ( const IndexedString & file ) const

pure virtual

Returns: all file items with the corresponding file path

◆ foldersForPath()

virtual QList<ProjectFolderItem*> KDevelop::IProject::foldersForPath ( const IndexedString & folder ) const

pure virtual

Returns: all folder items with the corresponding folder path

◆ inProject()

virtual bool KDevelop::IProject::inProject ( const IndexedString & path ) const

pure virtual

Check if the project contains an item with the given path.

Parameters

path	the path to check

Returns: true if the path path is a part of the project.

◆ isReady()

virtual bool KDevelop::IProject::isReady ( ) const

pure virtual

Returns whether the project is ready to be used or not.

A project won't be ready for use when it's being reloaded or still loading

◆ itemsForPath()

virtual QList<ProjectBaseItem*> KDevelop::IProject::itemsForPath ( const IndexedString & path ) const

pure virtual

Returns: all items with the corresponding path

◆ managerPlugin()

virtual IPlugin* KDevelop::IProject::managerPlugin ( ) const

pure virtual

Get the plugin that manages the project This can be used to get other interfaces like IBuildSystemManager.

◆ name()

virtual Q_SCRIPTABLE QString KDevelop::IProject::name ( ) const

pure virtual

Returns the name of the project.

◆ path()

virtual Path KDevelop::IProject::path ( ) const

pure virtual

Get the project path.

Returns: The canonical absolute directory of the project.

◆ projectConfiguration()

virtual KSharedConfigPtr KDevelop::IProject::projectConfiguration ( ) const

pure virtual

Get the url of the project file.

◆ projectFile()

virtual Path KDevelop::IProject::projectFile ( ) const

pure virtual

Returns: the path to the project file

◆ projectFileManager()

virtual 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

◆ projectItem()

virtual ProjectFolderItem* KDevelop::IProject::projectItem ( ) const

pure virtual

With this the top-level project item can be retrieved.

◆ reloadModel

virtual void KDevelop::IProject::reloadModel ( )

pure virtualslot

Make the model to reload.

◆ removeFromFileSet()

virtual void KDevelop::IProject::removeFromFileSet ( ProjectFileItem * item )

pure virtual

◆ setReloadJob()

virtual void KDevelop::IProject::setReloadJob ( KJob * job )

pure virtual

Tells the project what job is reloading it.

It's useful so that we can tell whether the project manager is busy or not.

◆ versionControlPlugin()

virtual 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.

Property Documentation

◆ projectName

QString KDevelop::IProject::projectName

read

Definition at line 62 of file iproject.h.

The documentation for this class was generated from the following files:

kdevplatform/interfaces

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IProject()

◆ ~IProject()

Member Function Documentation

◆ addToFileSet()

◆ buildSystemManager()

◆ close

◆ fileAddedToSet

◆ fileRemovedFromSet

◆ fileSet()

◆ filesForPath()

◆ foldersForPath()

◆ inProject()

◆ isReady()

◆ itemsForPath()

◆ managerPlugin()

◆ name()

◆ path()

◆ projectConfiguration()

◆ projectFile()

◆ projectFileManager()

◆ projectItem()

◆ reloadModel

◆ removeFromFileSet()

◆ setReloadJob()

◆ versionControlPlugin()

Property Documentation

◆ projectName

kdevplatform/interfaces

kdevelop API Reference

Search