QXmlAttributes Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QXmlAttributes Class Reference
[XML module]

The QXmlAttributes class provides XML attributes. More...

All the functions in this class are reentrant when Qt is built with thread support.

`#include <qxml.h>`

List of all member functions.

## Public Members

- QXmlAttributes ()
- virtual ~QXmlAttributes ()
- int index ( const QString & qName ) const
- int index ( const QString & uri, const QString & localPart ) const
- int length () const
- int count () const
- QString localName ( int index ) const
- QString qName ( int index ) const
- QString uri ( int index ) const
- QString type ( int index ) const
- QString type ( const QString & qName ) const
- QString type ( const QString & uri, const QString & localName ) const
- QString value ( int index ) const
- QString value ( const QString & qName ) const
- QString value ( const QString & uri, const QString & localName ) const
- void clear ()
- void append ( const QString & qName, const QString & uri, const QString & localPart, const QString & value )

## Detailed Description

The QXmlAttributes class provides XML attributes.

If attributes are reported by QXmlContentHandler::startElement() this class is used to pass the attribute values.

Use index() to locate the position of an attribute in the list, count() to retrieve the number of attributes, and clear() to remove the attributes. New attributes can be added with append(). Use type() to get an attribute's type and value() to get its value. The attribute's name is available from localName() or qName(), and its namespace URI from uri().

See also XML.

## Member Function Documentation

### QXmlAttributes::QXmlAttributes ()

Constructs an empty attribute list.

### QXmlAttributes::~QXmlAttributes ()`[virtual]`

Destroys the attributes object.

### void QXmlAttributes::append ( const QString & qName, const QString & uri, const QString & localPart, const QString & value )

Appends a new attribute entry to the list of attributes. The qualified name of the attribute is qName, the namespace URI is uri and the local name is localPart. The value of the attribute is value.

See also qName(), uri(), localName(), and value().

### void QXmlAttributes::clear ()

Clears the list of attributes.

See also append().

### int QXmlAttributes::count () const

Returns the number of attributes in the list. This function is equivalent to length().

### int QXmlAttributes::index ( const QString & qName ) const

Looks up the index of an attribute by the qualified name qName.

Returns the index of the attribute or -1 if it wasn't found.

See also the namespace description.

### int QXmlAttributes::index ( const QString & uri, const QString & localPart ) const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Looks up the index of an attribute by a namespace name.

uri specifies the namespace URI, or an empty string if the name has no namespace URI. localPart specifies the attribute's local name.

Returns the index of the attribute, or -1 if it wasn't found.

See also the namespace description.

### int QXmlAttributes::length () const

Returns the number of attributes in the list.

See also count().

Example: xml/tagreader-with-features/structureparser.cpp.

### QString QXmlAttributes::localName ( int index ) const

Looks up an attribute's local name for the attribute at position index. If no namespace processing is done, the local name is QString::null.

See also the namespace description.

### QString QXmlAttributes::qName ( int index ) const

Looks up an attribute's XML 1.0 qualified name for the attribute at position index.

See also the namespace description.

Example: xml/tagreader-with-features/structureparser.cpp.

### QString QXmlAttributes::type ( int index ) const

Looks up an attribute's type for the attribute at position index.

Currently only "CDATA" is returned.

### QString QXmlAttributes::type ( const QString & qName ) const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Looks up an attribute's type for the qualified name qName.

Currently only "CDATA" is returned.

### QString QXmlAttributes::type ( const QString & uri, const QString & localName ) const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Looks up an attribute's type by namespace name.

uri specifies the namespace URI and localName specifies the local name. If the name has no namespace URI, use an empty string for uri.

Currently only "CDATA" is returned.

### QString QXmlAttributes::uri ( int index ) const

Looks up an attribute's namespace URI for the attribute at position index. If no namespace processing is done or if the attribute has no namespace, the namespace URI is QString::null.

See also the namespace description.

Example: xml/tagreader-with-features/structureparser.cpp.

### QString QXmlAttributes::value ( int index ) const

Looks up an attribute's value for the attribute at position index.

### QString QXmlAttributes::value ( const QString & qName ) const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Looks up an attribute's value for the qualified name qName.

See also the namespace description.

### QString QXmlAttributes::value ( const QString & uri, const QString & localName ) const

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Looks up an attribute's value by namespace name.

uri specifies the namespace URI, or an empty string if the name has no namespace URI. localName specifies the attribute's local name.

See also the namespace description.

This file is part of the Qt toolkit. Copyright © 1995-2005 Trolltech. All Rights Reserved.