KItinerary::HtmlDocumentProcessor

Search for usage in LXR

KItinerary::HtmlDocumentProcessor Class Reference

#include <htmldocumentprocessor.h>

Inheritance diagram for KItinerary::HtmlDocumentProcessor:

Public Member Functions

bool canHandleData (const QByteArray &encodedData, QStringView fileName) const override
 
QJSValue contentToScriptValue (const ExtractorDocumentNode &node, QJSEngine *engine) const override
 
ExtractorDocumentNode createNodeFromContent (const QVariant &decodedData) const override
 
ExtractorDocumentNode createNodeFromData (const QByteArray &encodedData) const override
 
void destroyNode (ExtractorDocumentNode &node) const override
 
void expandNode (ExtractorDocumentNode &node, const ExtractorEngine *engine) const override
 
void preExtract (ExtractorDocumentNode &node, const ExtractorEngine *engine) const override
 
- Public Member Functions inherited from KItinerary::ExtractorDocumentProcessor
virtual bool matches (const ExtractorFilter &filter, const ExtractorDocumentNode &node) const
 
virtual void postExtract (ExtractorDocumentNode &node) const
 
virtual void reduceNode (ExtractorDocumentNode &node) const
 

Additional Inherited Members

- Protected Member Functions inherited from KItinerary::ExtractorDocumentProcessor
template<typename T >
void destroyIfOwned (ExtractorDocumentNode &node) const
 
- Static Protected Member Functions inherited from KItinerary::ExtractorDocumentProcessor
static bool matchesGadget (const ExtractorFilter &filter, const QMetaObject *mo, const void *obj)
 
template<typename T >
static bool matchesGadget (const ExtractorFilter &filter, const T *obj)
 

Detailed Description

Processor for HTML documents.

Definition at line 16 of file htmldocumentprocessor.h.

Member Function Documentation

bool HtmlDocumentProcessor::canHandleData ( const QByteArray encodedData,
QStringView  fileName 
) const
overridevirtual

Fast check whether the given encoded data can possibly be processed by this instance.

The default implementation returns false, relying on QMimeDatabase for detection.

Reimplemented from KItinerary::ExtractorDocumentProcessor.

Definition at line 38 of file htmldocumentprocessor.cpp.

QJSValue HtmlDocumentProcessor::contentToScriptValue ( const ExtractorDocumentNode node,
QJSEngine engine 
) const
overridevirtual

Create a QJSValue for the node content.

The default implementation is sufficient if the content is a QObject pointer, QGadget value, or any built-in type.

Reimplemented from KItinerary::ExtractorDocumentProcessor.

Definition at line 257 of file htmldocumentprocessor.cpp.

ExtractorDocumentNode HtmlDocumentProcessor::createNodeFromContent ( const QVariant decodedData) const
overridevirtual

Create a document node from an already decoded data type.

The default implementation just sets decodedData on the resulting node.

Reimplemented from KItinerary::ExtractorDocumentProcessor.

Definition at line 61 of file htmldocumentprocessor.cpp.

ExtractorDocumentNode HtmlDocumentProcessor::createNodeFromData ( const QByteArray encodedData) const
overridevirtual

Create a document node from raw data.

The default implementation produces in invalid node.

Reimplemented from KItinerary::ExtractorDocumentProcessor.

Definition at line 56 of file htmldocumentprocessor.cpp.

void HtmlDocumentProcessor::destroyNode ( ExtractorDocumentNode node) const
overridevirtual

Destroys type-specific data in node.

The default implementation does nothing.

Reimplemented from KItinerary::ExtractorDocumentProcessor.

Definition at line 262 of file htmldocumentprocessor.cpp.

void HtmlDocumentProcessor::expandNode ( ExtractorDocumentNode node,
const ExtractorEngine engine 
) const
overridevirtual

Create child nodes for node, as far as that's necessary for this document type.

Reimplemented from KItinerary::ExtractorDocumentProcessor.

Definition at line 69 of file htmldocumentprocessor.cpp.

void HtmlDocumentProcessor::preExtract ( ExtractorDocumentNode node,
const ExtractorEngine engine 
) const
overridevirtual

Called before extractors are applied to node.

This can be used for performing document type specific extraction steps. The default implementation does nothing.

Reimplemented from KItinerary::ExtractorDocumentProcessor.

Definition at line 245 of file htmldocumentprocessor.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Nov 30 2021 23:06:14 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.