Back to index

lightning-sunbird  0.9+nobinonly
Public Attributes
nsISAXLocator Interface Reference

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

import "nsISAXLocator.idl";

Inheritance diagram for nsISAXLocator:
Inheritance graph
[legend]
Collaboration diagram for nsISAXLocator:
Collaboration graph
[legend]

List of all members.

Public Attributes

readonly attribute long columnNumber
 Return the column number where the current document event ends.
readonly attribute long lineNumber
 Return the line number where the current document event ends.
readonly attribute AString publicId
 Return the public identifier for the current document event.
readonly attribute AString systemId
 Return the system identifier for the current document event.

Detailed Description

Interface for associating a SAX event with a document location.

Note that the results returned by the object will be valid only during the scope of each callback method: the application will receive unpredictable results if it attempts to use the locator at any other time, or after parsing completes.

Definition at line 49 of file nsISAXLocator.idl.


Member Data Documentation

Return the column number where the current document event ends.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. For example, when lines contain combining character sequences, wide characters, surrogate pairs, or bi-directional text, the value may not correspond to the column in a text editor's display.

The return value is an approximation of the column number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first column in each line is column 1.

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

Definition at line 72 of file nsISAXLocator.idl.

Return the line number where the current document event ends.

Lines are delimited by line ends, which are defined in the XML specification.

Warning: The return value from the method is intended only as an approximation for the sake of diagnostics; it is not intended to provide sufficient information to edit the character content of the original XML document. In some cases, these "line" numbers match what would be displayed as columns, and in others they may not match the source text due to internal entity expansion.

The return value is an approximation of the line number in the document entity or external parsed entity where the markup triggering the event appears.

If possible, the SAX driver should provide the line position of the first character after the text associated with the document event. The first line is line 1.

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

Definition at line 96 of file nsISAXLocator.idl.

Return the public identifier for the current document event.

The return value is the public identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

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

Definition at line 108 of file nsISAXLocator.idl.

Return the system identifier for the current document event.

The return value is the system identifier of the document entity or of the external parsed entity in which the markup triggering the event appears.

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

Definition at line 120 of file nsISAXLocator.idl.


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