Back to index

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

#include <nsSAXAttributes.h>

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

List of all members.

Public Member Functions

void addAttribute (in AString uri, in AString localName, in AString qName, in AString type, in AString value)
 Add an attribute to the end of the list.
void clear ()
 Clear the attribute list for reuse.
void removeAttribute (in unsigned long index)
 Remove an attribute from the list.
void setAttributes (in nsISAXAttributes attributes)
 Set the attributes list.
void setAttribute (in unsigned long index, in AString uri, in AString localName, in AString qName, in AString type, in AString value)
 Set an attribute in the list.
void setLocalName (in unsigned long index, in AString localName)
 Set the local name of a specific attribute.
void setQName (in unsigned long index, in AString qName)
 Set the qualified name of a specific attribute.
void setType (in unsigned long index, in AString type)
 Set the type of a specific attribute.
void setURI (in unsigned long index, in AString uri)
 Set the Namespace URI of a specific attribute.
void setValue (in unsigned long index, in AString value)
 Set the value of a specific attribute.
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.

Private Attributes

nsTArray< SAXAttrmAttrs

Detailed Description

Definition at line 63 of file nsSAXAttributes.h.


Member Function Documentation

void nsISAXMutableAttributes::addAttribute ( in AString  uri,
in AString  localName,
in AString  qName,
in AString  type,
in AString  value 
) [inherited]

Add an attribute to the end of the list.

For the sake of speed, this method does no checking to see if the attribute is already in the list: that is the responsibility of the application.

Parameters:
uriThe Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
localNameThe local name, or the empty string if Namespace processing is not being performed.
qNameThe qualified (prefixed) name, or the empty string if qualified names are not available.
typeThe attribute type as a string.
valueThe attribute value.

Clear the attribute list for reuse.

long nsISAXAttributes::getIndexFromName ( in AString  uri,
in AString  localName 
) [inherited]

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.
long nsISAXAttributes::getIndexFromQName ( in AString  qName) [inherited]

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) [inherited]

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) [inherited]

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) [inherited]

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 
) [inherited]

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) [inherited]

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) [inherited]

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) [inherited]

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 
) [inherited]

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) [inherited]

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.
void nsISAXMutableAttributes::removeAttribute ( in unsigned long  index) [inherited]

Remove an attribute from the list.

Parameters:
indexThe index of the attribute (zero-based).
void nsISAXMutableAttributes::setAttribute ( in unsigned long  index,
in AString  uri,
in AString  localName,
in AString  qName,
in AString  type,
in AString  value 
) [inherited]

Set an attribute in the list.

For the sake of speed, this method does no checking for name conflicts or well-formedness: such checks are the responsibility of the application.

Parameters:
indexThe index of the attribute (zero-based).
uriThe Namespace URI, or the empty string if none is available or Namespace processing is not being performed.
localNameThe local name, or the empty string if Namespace processing is not being performed.
qNameThe qualified name, or the empty string if qualified names are not available.
typeThe attribute type as a string.
valueThe attribute value.

Set the attributes list.

This method will clear any attributes in the list before adding the attributes from the argument.

Parameters:
attributesThe attributes object to replace populate the list with.
void nsISAXMutableAttributes::setLocalName ( in unsigned long  index,
in AString  localName 
) [inherited]

Set the local name of a specific attribute.

Parameters:
indexThe index of the attribute (zero-based).
localNameThe attribute's local name, or the empty string for none.
void nsISAXMutableAttributes::setQName ( in unsigned long  index,
in AString  qName 
) [inherited]

Set the qualified name of a specific attribute.

Parameters:
indexThe index of the attribute (zero-based).
qNameThe attribute's qualified name, or the empty string for none.
void nsISAXMutableAttributes::setType ( in unsigned long  index,
in AString  type 
) [inherited]

Set the type of a specific attribute.

Parameters:
indexThe index of the attribute (zero-based).
typeThe attribute's type.
void nsISAXMutableAttributes::setURI ( in unsigned long  index,
in AString  uri 
) [inherited]

Set the Namespace URI of a specific attribute.

Parameters:
indexThe index of the attribute (zero-based).
uriThe attribute's Namespace URI, or the empty string for none.
void nsISAXMutableAttributes::setValue ( in unsigned long  index,
in AString  value 
) [inherited]

Set the value of a specific attribute.

Parameters:
indexThe index of the attribute (zero-based).
valueThe attribute's value.

Member Data Documentation

readonly attribute long nsISAXAttributes::length [inherited]

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.

Definition at line 71 of file nsSAXAttributes.h.


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