• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KParts

  • KParts
  • ListingFilterExtension
Public Types | Public Member Functions | Static Public Member Functions | List of all members
KParts::ListingFilterExtension Class Referenceabstract

#include <listingextension.h>

Inheritance diagram for KParts::ListingFilterExtension:
QObject

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"

KParts::ListingFilterExtension* ext = KParts::ListingFilterExtension::childObject(part);
if (ext && (ext->supportedFilterModes() & KParts::ListingFilterExtension::SubString)) {
ext->setFilter(KParts::ListingFilterExtension::SubString, QLatin1String("kde"));
}
KParts::ListingFilterExtension
an extension for filtering listings.
Definition: listingextension.h:85
KParts::ListingFilterExtension::SubString
@ SubString
Definition: listingextension.h:95
KParts::ListingFilterExtension::childObject
static ListingFilterExtension * childObject(QObject *obj)
Queries obj for a child object which inherits from this class.
Definition: listingextension.cpp:36
KParts::ListingFilterExtension::supportedFilterModes
virtual FilterModes supportedFilterModes() const
Returns the OR'ed value of the file filter modes supported by the part that implements this extension...
Definition: listingextension.cpp:41
KParts::ListingFilterExtension::setFilter
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 ...

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"));
}
KParts::ListingFilterExtension::MimeType
@ MimeType
Definition: listingextension.h:94

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"));
}
KParts::ListingFilterExtension::WildCard
@ WildCard
Definition: listingextension.h:96

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);
}
KParts::ListingFilterExtension::supportsMultipleFilters
virtual bool supportsMultipleFilters(FilterMode mode) const
Returns true if the part that implements this extension allows the use of multiple filters for the gi...
Definition: listingextension.cpp:46
KParts::ListingFilterExtension::filter
virtual QVariant filter(FilterMode mode) const =0
Returns the currently set filters for the given mode.
mimeTypes
QStringList mimeTypes(Mode mode=Writing)
Since
4.9.2

Definition at line 84 of file listingextension.h.

Member Enumeration Documentation

◆ FilterMode

enum KParts::ListingFilterExtension::FilterMode

Supported file filtering modes modes.

Enumerator
None 
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 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()

KParts::ListingFilterExtension::~ListingFilterExtension ( )
virtual

Destructor

Definition at line 32 of file listingextension.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 36 of file listingextension.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.
filtersa 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 41 of file listingextension.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 46 of file listingextension.cpp.


The documentation for this class was generated from the following files:
  • listingextension.h
  • listingextension.cpp
This file is part of the KDE documentation.
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.

KParts

Skip menu "KParts"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal