Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
qgxml::Locator

qgxml::Locator Class Reference
[XML SAX Module]

#include <qgarlib/sax/Locator.H>

Inheritance diagram for qgxml::Locator:

qgxml::QtLocatorAdaptor qgxml::XercesLocatorAdaptor List of all members.

Detailed Description

Interface for associating a SAX event with a document location.

If a SAX parser provides location information to the SAX application, it does so by implementing this interface and then passing an instance to the application using the content handler's setDocumentLocator method. The application can use the object to obtain the location of any other SAX event in the XML source document.

This class is an adaptation for C++ of the interface of the same name implemented in the Java SAX API (http://www.saxproject.org).

Author:
Jan Rendek (Adaptation).
Date:
March 10, 2003 14:39
Since:
Qgar 2.1.1

Definition at line 71 of file Locator.H.

Public Member Functions

Destructor
virtual ~Locator ()
 Destructor.
Access
virtual int getColumnNumber () const =0
 Return the column number where the current document event ends.
virtual int getLineNumber () const =0
 Return the line number where the current document event ends.
virtual std::string getPublicId () const =0
 Return the public identifier for the current document event.
virtual std::string getSystemId () const =0
 Return the system identifier for the current document event.

Constructor & Destructor Documentation

virtual qgxml::Locator::~Locator (   )  [inline, virtual]
 

Destructor.

Definition at line 86 of file Locator.H.

Member Function Documentation

virtual int qgxml::Locator::getColumnNumber (   )  const [pure virtual]
 

Return the column number where the current document event ends.

Returns:
The column number.

Implemented in qgxml::QtLocatorAdaptor, and qgxml::XercesLocatorAdaptor.

virtual int qgxml::Locator::getLineNumber (   )  const [pure virtual]
 

Return the line number where the current document event ends.

Returns:
The line number.

Implemented in qgxml::QtLocatorAdaptor, and qgxml::XercesLocatorAdaptor.

virtual std::string qgxml::Locator::getPublicId (   )  const [pure virtual]
 

Return the public identifier for the current document event.

Returns:
A string containing the public identifier, or an empty string if none is available.

Implemented in qgxml::QtLocatorAdaptor, and qgxml::XercesLocatorAdaptor.

virtual std::string qgxml::Locator::getSystemId (   )  const [pure virtual]
 

Return the system identifier for the current document event.

Returns:
A string containing the system identifier, or an empty string if none is available.

Implemented in qgxml::QtLocatorAdaptor, and qgxml::XercesLocatorAdaptor.

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