Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsISAXAttributes Interface Reference

Interface for a list of XML attributes. More...

import "nsISAXAttributes.idl";

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

List of all members.

Public Member Functions

long getIndexFromName (in AString uri, in AString localName)
 Look up the index of an attribute by Namespace name.
long getIndexFromQName (in AString qName)
 Look up the index of an attribute by XML qualified name.
AString getLocalName (in unsigned long index)
 Look up an attribute's local name by index.
AString getQName (in unsigned long index)
 Look up an attribute's XML qualified name by index.
AString getType (in unsigned long index)
 Look up an attribute's type by index.
AString getTypeFromName (in AString uri, in AString localName)
 Look up an attribute's type by Namespace name.
AString getTypeFromQName (in AString qName)
 Look up an attribute's type by XML qualified name.
AString getURI (in unsigned long index)
 Look up an attribute's Namespace URI by index.
AString getValue (in unsigned long index)
 Look up an attribute's value by index.
AString getValueFromName (in AString uri, in AString localName)
 Look up an attribute's value by Namespace name.
AString getValueFromQName (in AString qName)
 Look up an attribute's value by XML qualified (prefixed) name.

Public Attributes

readonly attribute long length
 Return the number of attributes in the list.

Detailed Description

Interface for a list of XML attributes.

This interface allows access to a list of attributes in three different ways:

1.) by attribute index; 2.) by Namespace-qualified name; or 3.) by XML qualified name.

The list will not contain attributes that were declared #IMPLIED but not specified in the start tag. It will also not contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default).

The order of attributes in the list is unspecified.

Definition at line 59 of file nsISAXAttributes.idl.


Member Function Documentation

long nsISAXAttributes::getIndexFromName ( in AString  uri,
in AString  localName 
)

Look up the index of an attribute by Namespace name.

Parameters:
uriThe Namespace URI, or the empty string if the name has no Namespace URI.
localNameThe attribute's local name.
Returns:
The index of the attribute, or -1 if it does not appear in the list.

Look up the index of an attribute by XML qualified name.

Parameters:
qNameThe qualified name.
Returns:
The index of the attribute, or -1 if it does not appear in the list.
AString nsISAXAttributes::getLocalName ( in unsigned long  index)

Look up an attribute's local name by index.

Parameters:
indexThe attribute index (zero-based).
Returns:
The local name, or null if the index is out of range.
AString nsISAXAttributes::getQName ( in unsigned long  index)

Look up an attribute's XML qualified name by index.

Parameters:
indexThe attribute index (zero-based).
Returns:
The XML qualified name, or the empty string if none is available, or null if the index is out of range.
AString nsISAXAttributes::getType ( in unsigned long  index)

Look up an attribute's type by index.

The attribute type is one of the strings "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", or "NOTATION" (always in upper case). If the parser has not read a declaration for the attribute, or if the parser does not report attribute types, then it must return the value "CDATA" as stated in the XML 1.0 Recommendation (clause 3.3.3, "Attribute-Value Normalization"). For an enumerated attribute that is not a notation, the parser will report the type as "NMTOKEN".

Parameters:
indexThe attribute index (zero-based).
Returns:
The attribute's type as a string, or null if the index is out of range.
AString nsISAXAttributes::getTypeFromName ( in AString  uri,
in AString  localName 
)

Look up an attribute's type by Namespace name.

Parameters:
uriThe Namespace URI, or the empty string if the name has no Namespace URI.
localNameThe attribute's local name.
Returns:
The attribute type as a string, or null if the attribute is not in the list.
AString nsISAXAttributes::getTypeFromQName ( in AString  qName)

Look up an attribute's type by XML qualified name.

Parameters:
qNameThe qualified name.
Returns:
The attribute type as a string, or null if the attribute is not in the list.
AString nsISAXAttributes::getURI ( in unsigned long  index)

Look up an attribute's Namespace URI by index.

Parameters:
indexThe attribute index (zero-based).
Returns:
The Namespace URI, or the empty string if none is available, or null if the index is out of range.
AString nsISAXAttributes::getValue ( in unsigned long  index)

Look up an attribute's value by index.

If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Parameters:
indexThe attribute index (zero-based).
Returns:
The attribute's value as a string, or null if the index is out of range.
AString nsISAXAttributes::getValueFromName ( in AString  uri,
in AString  localName 
)

Look up an attribute's value by Namespace name.

If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Parameters:
uriThe Namespace URI, or the empty string if the name has no Namespace URI.
localNameThe attribute's local name.
Returns:
The attribute's value as a string, or null if the attribute is not in the list.
AString nsISAXAttributes::getValueFromQName ( in AString  qName)

Look up an attribute's value by XML qualified (prefixed) name.

If the attribute value is a list of tokens (IDREFS, ENTITIES, or NMTOKENS), the tokens will be concatenated into a single string with each token separated by a single space.

Parameters:
qNameThe qualified (prefixed) name.
Returns:
The attribute's value as a string, or null if the attribute is not in the list.

Member Data Documentation

Return the number of attributes in the list.

Once you know the number of attributes, you can iterate through the list.

Returns:
The number of attributes in the list.

Definition at line 85 of file nsISAXAttributes.idl.


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