KParts::ListingFilterExtension

Search for usage in LXR

KParts::ListingFilterExtension Class Referenceabstract

#include <KParts/ListingFilterExtension>

Inheritance diagram for KParts::ListingFilterExtension:

Public Types

enum  FilterMode { None = 0x00, MimeType = 0x01, SubString = 0x02, WildCard = 0x04 }
 
typedef QFlags< FilterModeFilterModes
 

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)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static ListingFilterExtensionchildObject (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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () 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"

To show items that only match "text/html"

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

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

Since
4.9.2

Definition at line 74 of file listingfilterextension.h.

Member Typedef Documentation

◆ FilterModes

Stores a combination of FilterMode values.

Definition at line 93 of file listingfilterextension.h.

Member Enumeration Documentation

◆ 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
modethe 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
modethe desired filter mode as specified in FilterMode.
filtera 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:
static ListingFilterExtension * childObject(QObject *obj)
Queries obj for a child object which inherits from this class.
virtual FilterModes supportedFilterModes() const
Returns the OR'ed value of the file filter modes supported by the part that implements this extension...
virtual void setFilter(FilterMode mode, const QVariant &filter)=0
Sets the file filter that should be applied by the part that implements this extension for the given ...
An extension for filtering listings.
virtual QVariant filter(FilterMode mode) const =0
Returns the currently set filters for the given mode.
QStringList mimeTypes(Mode mode=Writing)
QStringList toStringList() const const
virtual bool supportsMultipleFilters(FilterMode mode) const
Returns true if the part that implements this extension allows the use of multiple filters for the gi...
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Mon Oct 3 2022 03:55:58 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.