KParts
#include <listingextension.h>
Public Types | |
enum | FilterMode { None = 0x00, MimeType = 0x01, SubString = 0x02, WildCard = 0x04 } |
Public Member Functions | |
ListingFilterExtension (KParts::ReadOnlyPart *parent) | |
virtual | ~ListingFilterExtension () |
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) | |
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 QObject *receiver, const char *method) |
bool | disconnect (const char *signal, 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 ®Exp) 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 |
Static Public Member Functions | |
static ListingFilterExtension * | childObject (QObject *obj) |
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) |
Additional Inherited Members | |
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
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 84 of file listingextension.h.
Member Enumeration Documentation
Supported file filtering modes modes.
Definition at line 92 of file listingextension.h.
Constructor & Destructor Documentation
KParts::ListingFilterExtension::ListingFilterExtension | ( | KParts::ReadOnlyPart * | parent | ) |
Constructor
Definition at line 26 of file listingextension.cpp.
|
virtual |
Destructor
Definition at line 32 of file listingextension.cpp.
Member Function Documentation
|
static |
Queries obj
for a child object which inherits from this class.
Definition at line 36 of file listingextension.cpp.
|
pure virtual |
Returns the currently set filters for the given mode
.
- Parameters
-
mode the desired filter mode as specified in FilterMode.
|
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. filters a list of filter texts based on the selected mode.
|
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 41 of file listingextension.cpp.
|
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 46 of file listingextension.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:25:36 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.