Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes | Private Attributes
nsSAXLocator Class Reference

#include <nsSAXLocator.h>

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

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSISAXLOCATOR 
nsSAXLocator ()
NS_IMETHOD SetColumnNumber (PRInt32 aColumnNumber)
NS_IMETHOD SetLineNumber (PRInt32 aLineNumber)
NS_IMETHOD SetSystemId (const nsAString &aSystemId)
NS_IMETHOD SetPublicId (const nsAString &aPublicId)

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.

Private Attributes

nsString mPublicId
nsString mSystemId
PRInt32 mLineNumber
PRInt32 mColumnNumber

Detailed Description

Definition at line 51 of file nsSAXLocator.h.


Constructor & Destructor Documentation

Definition at line 42 of file nsSAXLocator.cpp.

                           : mLineNumber(0), mColumnNumber(0)
{
}

Member Function Documentation

Definition at line 75 of file nsSAXLocator.cpp.

{
  mColumnNumber = aColumnNumber;
  return NS_OK;
}

Definition at line 82 of file nsSAXLocator.cpp.

{
  mLineNumber = aLineNumber;
  return NS_OK;
}
NS_IMETHODIMP nsSAXLocator::SetPublicId ( const nsAString &  aPublicId)

Definition at line 96 of file nsSAXLocator.cpp.

{
  mPublicId = aPublicId;
  return NS_OK;
}
NS_IMETHODIMP nsSAXLocator::SetSystemId ( const nsAString &  aSystemId)

Definition at line 89 of file nsSAXLocator.cpp.

{
  mSystemId = aSystemId;
  return NS_OK;
}

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.

Definition at line 68 of file nsSAXLocator.h.

Definition at line 67 of file nsSAXLocator.h.

Definition at line 65 of file nsSAXLocator.h.

Definition at line 66 of file nsSAXLocator.h.

readonly attribute AString nsISAXLocator::publicId [inherited]

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.

readonly attribute AString nsISAXLocator::systemId [inherited]

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 class was generated from the following files: