KParts::SelectorInterface Class Reference

Optional base class for HtmlExtension-derived classes Provides DOM Selector like API: querySelector and querySelectorAll, in order to find specific elements in an HTML document. More...

#include <htmlextension.h>

List of all members.

Classes
class	Element
Public Types
enum	QueryMethod { None = 0x00, EntireContent = 0x01, SelectedContent = 0x02 }
Public Member Functions
virtual	~SelectorInterface ()
virtual Element	querySelector (const QString &query, QueryMethod method) const =0
virtual QList< Element >	querySelectorAll (const QString &query, QueryMethod method) const =0
virtual QueryMethods	supportedQueryMethods () const

---

Detailed Description

Optional base class for HtmlExtension-derived classes Provides DOM Selector like API: querySelector and querySelectorAll, in order to find specific elements in an HTML document.

Example: const QList<SelectorInterface::Element> elements = selectorInterface->querySelectorAll("head > link[rel=\"alternate"]");

Definition at line 89 of file htmlextension.h.

---

Member Enumeration Documentation

enum KParts::SelectorInterface::QueryMethod

Query methods.

Enumerator:

None	Quering is not possible.
EntireContent	Query or can query the entire content.
SelectedContent	Query or can query only the user selected content, if any.

Definition at line 98 of file htmlextension.h.

---

Constructor & Destructor Documentation

virtual KParts::SelectorInterface::~SelectorInterface

(

)

[inline, virtual]

Destructor.

Definition at line 108 of file htmlextension.h.

---

Member Function Documentation

virtual Element KParts::SelectorInterface::querySelector	(	const QString &	query,
		QueryMethod	method
	)		const [pure virtual]

Returns the first (in document order) element in this fragment matching the given CSS selector query and querying method method.

Note that since the returned item is static snapshot, i.e. not live, it will not be updated when the document changes.

If the quering method specified by method is not supported or cannot be handled, then a null element is returned.

See also:

supportedQueryMethods

QueryMethod

virtual QList<Element> KParts::SelectorInterface::querySelectorAll	(	const QString &	query,
		QueryMethod	method
	)		const [pure virtual]

Returns all (in document order) elements in this fragment matching the given CSS selector query and querying method method.

Note that since the returned list is static snapshot, i.e. not live, it will not be updated when the document changes.

If the quering method specified by method is not supported or cannot be handled, then an empty list is returned.

See also:

supportedQueryMethods

QueryMethod

SelectorInterface::QueryMethods SelectorInterface::supportedQueryMethods

(

)

const [virtual]

Returns the supported query methods.

By default this function returns None.

See also:

QueryMethod

Definition at line 48 of file htmlextension.cpp.

---

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

• htmlextension.h
• htmlextension.cpp