KItinerary::ExtractorFilter
#include <extractorfilter.h>
Public Types | |
enum | Scope { Current , Parent , Children , Ancestors , Descendants } |
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 |
ExtractorFilter & | operator= (const ExtractorFilter &) |
ExtractorFilter & | operator= (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.
Definition at line 44 of file extractorfilter.h.
Constructor & Destructor Documentation
◆ ExtractorFilter()
ExtractorFilter::ExtractorFilter | ( | ) |
Definition at line 32 of file extractorfilter.cpp.
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 235 of file extractorfilter.cpp.
◆ fieldName()
QString ExtractorFilter::fieldName | ( | ) | const |
The field to filter on.
Definition at line 54 of file extractorfilter.cpp.
◆ matches() [1/2]
bool ExtractorFilter::matches | ( | const ExtractorDocumentNode & | node | ) | const |
Checks whether this filter applies to node
.
Definition at line 214 of file extractorfilter.cpp.
◆ matches() [2/2]
bool ExtractorFilter::matches | ( | const QString & | data | ) | const |
Check if data
matches this filter.
Definition at line 65 of file extractorfilter.cpp.
◆ mimeType()
QString ExtractorFilter::mimeType | ( | ) | const |
MIME type of the document part this filter can match.
Definition at line 43 of file extractorfilter.cpp.
◆ pattern()
QString ExtractorFilter::pattern | ( | ) | const |
Pattern to match field value against.
Definition at line 121 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 132 of file extractorfilter.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 16:56:37 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.