Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members  

saxILocator Interface Reference

Interface for associating a SAX event with a document location. More...

#include <saxILocator.idl>

Inheritance diagram for saxILocator

Inheritance graph

[legend]
Collaboration diagram for saxILocator:

Collaboration graph

[legend]
List of all members.

Public Attributes

attribute wstring PublicId
 Return the public identifier for the current document event. More...

attribute wstring SystemId
 Return the system identifier for the current document event. More...

attribute unsigned long LineNumber
 Return the line number where the current document event ends. More...

attribute unsigned long ColumnNumber
 Return the column number where the current document event ends. More...


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 document handler's setDocumentLocator method. The application can use the object to obtain the location of any other document handler event in the XML source document.

Note that the results returned by the object will be valid only during the scope of each document handler method: the application will receive unpredictable results if it attempts to use the locator at any other time.

SAX parsers are not required to supply a locator, but they are very strong encouraged to do so. If the parser supplies a locator, it must do so before reporting any other document events. If no locator has been set by the time the application receives the startDocument event, the application should assume that a locator is not available.

Version:
Revision:
See also:
DocumentHandler::setDocumentLocator

Definition at line 40 of file saxILocator.idl.


Member Data Documentation

attribute unsigned long saxILocator::ColumnNumber
 

Return the column number where the current document event ends.

Note that this is the column number of the first character after the text associated with the document event. The first column in a line is position 1.

Returns:
The column number, or -1 if none is available.
See also:
getLineNumber

Definition at line 80 of file saxILocator.idl.

attribute unsigned long saxILocator::LineNumber
 

Return the line number where the current document event ends.

Note that this is the line position of the first character after the text associated with the document event.

Returns:
The line number, or -1 if none is available.
See also:
getColumnNumber

Definition at line 70 of file saxILocator.idl.

attribute wstring saxILocator::PublicId
 

Return the public identifier for the current document event.

This will be the public identifier

Returns:
A string containing the public identifier, or null if none is available.
See also:
getSystemId

Definition at line 49 of file saxILocator.idl.

attribute wstring saxILocator::SystemId
 

Return the system identifier for the current document event.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Returns:
A string containing the system identifier, or null if none is available.
See also:
getPublicId

Definition at line 61 of file saxILocator.idl.


The documentation for this interface was generated from the following file:
Generated at Tue Sep 12 17:04:53 2000 by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000