#include <projectfiltermanager.h>

Inheritance diagram for KDevelop::ProjectFilterManager:

Public Member Functions
	ProjectFilterManager (QObject *parent=nullptr)

	~ProjectFilterManager () override

void	add (IProject *project)

QVector< QSharedPointer< IProjectFilter > >	filtersForProject (IProject *project) const

bool	isManaged (IProject *project) const

bool	isValid (const Path &path, bool isFolder, IProject *project) const

void	remove (IProject *project)

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

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)

Properties inherited from QObject
	objectName

Detailed Description

A helper class to manage project filtering in file managers.

Use this class in implementations of IProjectFileManager to simplify the management of IProjectFilter instances for projects managed by your file manager.

NOTE: This interface is not threadsafe. But you can use filtersForProject() to implement thread safe filtering.

Author: Milian Wolff

Definition at line 52 of file projectfiltermanager.h.

Constructor & Destructor Documentation

◆ ProjectFilterManager()

ProjectFilterManager::ProjectFilterManager ( QObject * parent = nullptr )

explicit

Definition at line 130 of file projectfiltermanager.cpp.

◆ ~ProjectFilterManager()

ProjectFilterManager::~ProjectFilterManager ( )

override

Definition at line 149 of file projectfiltermanager.cpp.

Member Function Documentation

◆ add()

void ProjectFilterManager::add ( IProject * project )

Manage the filters of the given project.

Definition at line 154 of file projectfiltermanager.cpp.

◆ filtersForProject()

QVector< QSharedPointer< IProjectFilter > > ProjectFilterManager::filtersForProject ( IProject * project ) const

Returns: the current list of project filters for a given managed project.

This can be used to implement a thread safe project filtering

Definition at line 193 of file projectfiltermanager.cpp.

◆ isManaged()

bool ProjectFilterManager::isManaged ( IProject * project ) const

TODO: remove this once the cmake manager got cleaned up to not need this anymore.

Returns: true if the project is managed, false otherwise.

Definition at line 176 of file projectfiltermanager.cpp.

◆ isValid()

bool ProjectFilterManager::isValid	(	const Path &	path,
		bool	isFolder,
		IProject *	project
	)		const

Check whether the given path should be included in a project.

Parameters

path	is the path that you want to be checked.
isFolder	distinguishes between files and folders.

Returns: true when the given path should be included in the project, false otherwise, i.e. when the path should be hidden.

Definition at line 183 of file projectfiltermanager.cpp.

◆ remove()

void ProjectFilterManager::remove ( IProject * project )

Remove the managed filters of the given project.

Definition at line 169 of file projectfiltermanager.cpp.

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

kdevplatform/project

Public Member Functions

Additional Inherited Members