QXmlAttributes Class

The QXmlAttributes class provides XML attributes. More...

Header: #include <QXmlAttributes>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core5Compat)
target_link_libraries(mytarget PRIVATE Qt6::Core5Compat)
qmake: QT += core5compat

Note: All functions in this class are reentrant.

Public Functions

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

Detailed Description

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().

Member Function Documentation

QXmlAttributes::QXmlAttributes()

Constructs an empty attribute list.

[virtual noexcept] QXmlAttributes::~QXmlAttributes()

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.

int QXmlAttributes::index(QLatin1String qName) const

This is an overloaded function.

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

This is an overloaded 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.

int QXmlAttributes::length() const

Returns the number of attributes in the list.

See also count().

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 an empty string.

QString QXmlAttributes::qName(int index) const

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

[noexcept] void QXmlAttributes::swap(QXmlAttributes &other)

Swaps this with other.

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 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 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 an empty string.

QString QXmlAttributes::value(int index) const

Returns an attribute's value for the attribute at position index. The index must be a valid position (i.e., 0 <= index < count()).

QString QXmlAttributes::value(QLatin1String qName) const

This is an overloaded function.

Returns an attribute's value for the qualified name qName, or an empty string if no attribute exists for the name given.

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

This is an overloaded function.

Returns an attribute's value for the qualified name qName, or an empty string if no attribute exists for the name given.

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

This is an overloaded function.

Returns 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.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.