KParts::ListingFilterExtension

#include <KParts/ListingFilterExtension>

Inheritance diagram for KParts::ListingFilterExtension:

Public Types
enum	FilterMode { None = 0x00 , MimeType = 0x01 , SubString = 0x02 , WildCard = 0x04 }

typedef QFlags< FilterMode >	FilterModes

Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
	ListingFilterExtension (KParts::ReadOnlyPart *parent)

	~ListingFilterExtension () override

virtual QVariant	filter (FilterMode mode) const =0

virtual void	setFilter (FilterMode mode, const QVariant &filter)=0

virtual FilterModes	supportedFilterModes () const

virtual bool	supportsMultipleFilters (FilterMode mode) const

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

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

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

void	deleteLater ()

void	destroyed (QObject *obj)

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

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

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

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

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

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static ListingFilterExtension *	childObject (QObject *obj)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

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)

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

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

Additional Inherited Members
Properties inherited from QObject
	objectName

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

An extension for filtering listings.

This extension is intended to be implemented by parts that provide listing services, e.g. file management parts and is intended to provide a generic API for filtering any listing through keywords, wildcard characters and/or content-type.

Examples:

To show items that only match the term "kde"

KParts::ListingFilterExtension* ext = KParts::ListingFilterExtension::childObject(part);
if (ext && (ext->supportedFilterModes() & KParts::ListingFilterExtension::SubString)) {
   ext->setFilter(KParts::ListingFilterExtension::SubString, QLatin1String("kde"));
}

To show items that only match "text/html"

KParts::ListingFilterExtension* ext = KParts::ListingFilterExtension::childObject(part);
if (ext && (ext->supportedFilterModes() & KParts::ListingFilterExtension::MimeType)) {
    ext->setFilter(KParts::ListingFilterExtension::MimeType, QLatin1String("text/html"));
}

To show items that only match the wildcard string "*.txt"

KParts::ListingFilterExtension* ext = KParts::ListingFilterExtension::childObject(part);
if (ext && (ext->supportedFilterModes() & KParts::ListingFilterExtension::WildCard)) {
    ext->setFilter(KParts::ListingFilterExtension::WildCard, QLatin1String("*.txt"));
}

To show items that match multiple mime types, e.g. text/html & application/xml:

KParts::ListingFilterExtension* ext = KParts::ListingFilterExtension::childObject(part);
if (ext &&
    (ext->supportedFilterModes() & KParts::ListingFilterExtension::MimeType) &&
    ext->supportsMultipleFilters(KParts::ListingFilterExtension::MimeType)) {
    QStringList mimeTypes = ext->filter(KParts::ListingFilterExtension::MimeType).toStringList();
    mimeTypes << QLatin1String("text/html") << QLatin1String("application/xml");
    ext->setFilter(KParts::ListingFilterExtension::MimeType, mimeTypes);
}

Since: 4.9.2

Definition at line 74 of file listingfilterextension.h.

Member Typedef Documentation

◆ FilterModes

QFlags< FilterMode > KParts::ListingFilterExtension::FilterModes

Stores a combination of FilterMode values.

Definition at line 93 of file listingfilterextension.h.

Member Enumeration Documentation

◆ FilterMode

enum KParts::ListingFilterExtension::FilterMode

Supported file filtering modes modes.

@FilterModes

Enumerator
MimeType	Filter by mime type, e.g. "text/plain".
SubString	Filter by matching any part of a file or directory name, e.g. "Documents"
WildCard	Filter by using wildcard matches, e.g. "*.txt"

Definition at line 83 of file listingfilterextension.h.

Constructor & Destructor Documentation

◆ ListingFilterExtension()

KParts::ListingFilterExtension::ListingFilterExtension ( KParts::ReadOnlyPart * parent )

explicit

Constructor

Definition at line 16 of file listingfilterextension.cpp.

◆ ~ListingFilterExtension()

KParts::ListingFilterExtension::~ListingFilterExtension ( )

override

Destructor

Definition at line 22 of file listingfilterextension.cpp.

Member Function Documentation

◆ childObject()

KParts::ListingFilterExtension * KParts::ListingFilterExtension::childObject ( QObject * obj )

static

Queries obj for a child object which inherits from this class.

Definition at line 26 of file listingfilterextension.cpp.

◆ filter()

virtual QVariant KParts::ListingFilterExtension::filter ( FilterMode mode ) const

pure virtual

Returns the currently set filters for the given mode.

Parameters

mode	the desired filter mode as specified in FilterMode.

◆ setFilter()

virtual void KParts::ListingFilterExtension::setFilter	(	FilterMode	mode,
		const QVariant &	filter )

pure virtual

Sets the file filter that should be applied by the part that implements this extension for the given filtering mode.

To remove a filter for a given filter mode, simply call this function with the desired mode and the filter parameter set to a NULL variant.

The second parameter can be

Parameters

mode	the desired filter mode as specified in FilterMode.
filter	a list of filter texts based on the selected mode.

◆ supportedFilterModes()

KParts::ListingFilterExtension::FilterModes KParts::ListingFilterExtension::supportedFilterModes ( ) const

virtual

Returns the OR'ed value of the file filter modes supported by the part that implements this extension.

By default this function returns None.

Definition at line 31 of file listingfilterextension.cpp.

◆ supportsMultipleFilters()

bool KParts::ListingFilterExtension::supportsMultipleFilters ( FilterMode mode ) const

virtual

Returns true if the part that implements this extension allows the use of multiple filters for the given filtering mode.

By default this function returns false.

Definition at line 36 of file listingfilterextension.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KParts