KItinerary::ExtractorFilter Class Reference

#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

enum KItinerary::ExtractorFilter::Scope

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

Enumerator
Current	match the node being extracted
Parent	match the direct parent node
Children	match the direct child nodes
Ancestors	match any direct or indirect parent nodes
Descendants	match any direct or indirect child nodes

Definition at line 44 of file extractorfilter.h.

Constructor & Destructor Documentation

ExtractorFilter()

ExtractorFilter::ExtractorFilter

(

)

Definition at line 31 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 238 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 217 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 120 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 131 of file extractorfilter.cpp.

---

The documentation for this class was generated from the following files:

• extractorfilter.h
• extractorfilter.cpp