Search for usage in LXR

KItinerary::ExtractorFilter Class Reference

#include <extractorfilter.h>

Public Types

enum  Scope {
  Current, Parent, Children, Ancestors,

Public Member Functions

 ExtractorFilter (const ExtractorFilter &)
 ExtractorFilter (ExtractorFilter &&) noexcept
void allMatches (const ExtractorDocumentNode &node, std::vector< ExtractorDocumentNode > &matches) const
QString fieldName () const
bool matches (const ExtractorDocumentNode &node) const
bool matches (const QString &data) const
QString mimeType () const
ExtractorFilteroperator= (const ExtractorFilter &)
ExtractorFilteroperator= (ExtractorFilter &&)
QString pattern () const
Scope scope () const

Detailed Description

Determines whether an extractor is applicable to a given email.

Definition at line 23 of file extractorfilter.h.

Member Enumeration Documentation

◆ Scope

Specifies which document nodes should match this filter, relative to the one being extracted.


match the node being extracted


match the direct parent node


match the direct child nodes


match any direct or indirect parent nodes


match any direct or indirect child nodes

Definition at line 44 of file extractorfilter.h.

Member Function Documentation

◆ allMatches()

void ExtractorFilter::allMatches ( const ExtractorDocumentNode node,
std::vector< ExtractorDocumentNode > &  matches 
) const

Checks whether this filter applies to node.

Unlike matches() this returns all nodes triggering this filter. This matters in particular for matching child nodes, where multiple ones can match the filter.

Definition at line 228 of file extractorfilter.cpp.

◆ fieldName()

QString ExtractorFilter::fieldName ( ) const

The field to filter on.

Definition at line 53 of file extractorfilter.cpp.

◆ matches() [1/2]

bool ExtractorFilter::matches ( const ExtractorDocumentNode node) const

Checks whether this filter applies to node.

Definition at line 207 of file extractorfilter.cpp.

◆ matches() [2/2]

bool ExtractorFilter::matches ( const QString data) const

Check if data matches this filter.

Definition at line 64 of file extractorfilter.cpp.

◆ mimeType()

QString ExtractorFilter::mimeType ( ) const

MIME type of the document part this filter can match.

Definition at line 42 of file extractorfilter.cpp.

◆ pattern()

QString ExtractorFilter::pattern ( ) const

Pattern to match field value against.

Definition at line 115 of file extractorfilter.cpp.

◆ scope()

ExtractorFilter::Scope ExtractorFilter::scope ( ) const

Evaluation scope of this filter, in relation to the node being extracted.

Definition at line 126 of file extractorfilter.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Sep 30 2022 04:04:04 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.