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 |
Static Public Member Functions | |
static ListingFilterExtension * | childObject (QObject *obj) |
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
◆ FilterMode
Supported file filtering modes modes.
Definition at line 92 of file listingextension.h.
Constructor & Destructor Documentation
◆ ListingFilterExtension()
KParts::ListingFilterExtension::ListingFilterExtension | ( | KParts::ReadOnlyPart * | parent | ) |
Constructor
Definition at line 26 of file listingextension.cpp.
◆ ~ListingFilterExtension()
|
virtual |
Destructor
Definition at line 32 of file listingextension.cpp.
Member Function Documentation
◆ childObject()
|
static |
Queries obj
for a child object which inherits from this class.
Definition at line 36 of file listingextension.cpp.
◆ filter()
|
pure virtual |
Returns the currently set filters for the given mode
.
- Parameters
-
mode the desired filter mode as specified in FilterMode.
◆ setFilter()
|
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.
◆ supportedFilterModes()
|
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.
◆ supportsMultipleFilters()
|
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-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.