# XQilla Simple API Documentation

# EventFilter Class Reference

`#include <EventHandler.hpp>`

Inheritance diagram for EventFilter:
[legend]

List of all members.

## Public Member Functions

| EventFilter (EventHandler *next)
void | setNextEventHandler (EventHandler *next)
virtual void | setLocationInfo (const LocationInfo *location)
| Recieves a LocationInfo object that is owned by the caller, and will be updated with the current location information as the parse progresses.
virtual void | startDocumentEvent (const XMLCh *documentURI, const XMLCh *encoding)
| Handles a document node as an event.
virtual void | endDocumentEvent ()
| Handles a document node as an event.
virtual void | startElementEvent (const XMLCh *prefix, const XMLCh *uri, const XMLCh *localname)
| Handles the start of an element node as an event.
virtual void | endElementEvent (const XMLCh *prefix, const XMLCh *uri, const XMLCh *localname, const XMLCh *typeURI, const XMLCh *typeName)
| Handles the end of an element node as an event.
virtual void | piEvent (const XMLCh *target, const XMLCh *value)
| Handles a processing instruction node as an event.
virtual void | textEvent (const XMLCh *value)
| Handles a text node as an event.
virtual void | textEvent (const XMLCh *chars, unsigned int length)
| Handles a text node as an event.
virtual void | commentEvent (const XMLCh *value)
| Handles a comment node as an event.
virtual void | attributeEvent (const XMLCh *prefix, const XMLCh *uri, const XMLCh *localname, const XMLCh *value, const XMLCh *typeURI, const XMLCh *typeName)
| Handles an attribute node as an event.
virtual void | namespaceEvent (const XMLCh *prefix, const XMLCh *uri)
| Handles a namespace binding as an event.
virtual void | atomicItemEvent (AnyAtomicType::AtomicObjectType type, const XMLCh *value, const XMLCh *typeURI, const XMLCh *typeName)
| Handles an atomic item as an event.
virtual void | endEvent ()
| Called when all events have been reported.

## Protected Attributes

EventHandler * | next_

## Constructor & Destructor Documentation

EventFilter::EventFilter | ( | EventHandler * | next | ) | `[inline]`

## Member Function Documentation

virtual void EventFilter::atomicItemEvent | ( | AnyAtomicType::AtomicObjectType | type,
|  | const XMLCh * | value,
|  | const XMLCh * | typeURI,
|  | const XMLCh * | typeName |
| ) |  |  | `[inline, virtual]`

Handles an atomic item as an event.

Reimplemented from EventHandler.

Reimplemented in ContentSequenceFilter.

virtual void EventFilter::attributeEvent | ( | const XMLCh * | prefix,
|  | const XMLCh * | uri,
|  | const XMLCh * | localname,
|  | const XMLCh * | value,
|  | const XMLCh * | typeURI,
|  | const XMLCh * | typeName |
| ) |  |  | `[inline, virtual]`

Handles an attribute node as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, NSFixupFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::commentEvent | ( | const XMLCh * | value | ) | `[inline, virtual]`

Handles a comment node as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::endDocumentEvent | ( |  | ) | `[inline, virtual]`

Handles a document node as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, NSFixupFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::endElementEvent | ( | const XMLCh * | prefix,
|  | const XMLCh * | uri,
|  | const XMLCh * | localname,
|  | const XMLCh * | typeURI,
|  | const XMLCh * | typeName |
| ) |  |  | `[inline, virtual]`

Handles the end of an element node as an event.

Implements EventHandler.

Reimplemented in NSFixupFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::endEvent | ( |  | ) | `[inline, virtual]`

Called when all events have been reported.

Implements EventHandler.

Reimplemented in ContentSequenceFilter.

virtual void EventFilter::namespaceEvent | ( | const XMLCh * | prefix,
|  | const XMLCh * | uri |
| ) |  |  | `[inline, virtual]`

Handles a namespace binding as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, NSFixupFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::piEvent | ( | const XMLCh * | target,
|  | const XMLCh * | value |
| ) |  |  | `[inline, virtual]`

Handles a processing instruction node as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::setLocationInfo | ( | const LocationInfo * | location | ) | `[inline, virtual]`

Recieves a LocationInfo object that is owned by the caller, and will be updated with the current location information as the parse progresses.

Reimplemented from EventHandler.

void EventFilter::setNextEventHandler | ( | EventHandler * | next | ) | `[inline]`

virtual void EventFilter::startDocumentEvent | ( | const XMLCh * | documentURI,
|  | const XMLCh * | encoding |
| ) |  |  | `[inline, virtual]`

Handles a document node as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, NSFixupFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::startElementEvent | ( | const XMLCh * | prefix,
|  | const XMLCh * | uri,
|  | const XMLCh * | localname |
| ) |  |  | `[inline, virtual]`

Handles the start of an element node as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, NSFixupFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::textEvent | ( | const XMLCh * | chars,
|  | unsigned int | length |
| ) |  |  | `[inline, virtual]`

Handles a text node as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

virtual void EventFilter::textEvent | ( | const XMLCh * | value | ) | `[inline, virtual]`

Handles a text node as an event.

Implements EventHandler.

Reimplemented in ContentSequenceFilter, QueryPathTreeFilter, and SchemaValidatorFilter.

## Member Data Documentation

EventHandler* EventFilter::next_ `[protected]`

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

- EventHandler.hpp