Qt Toolkit - QXmlNamespaceSupport Class

| Classes - Annotated - Tree - Functions - Home - Structure

# QXmlNamespaceSupport Class Reference
[ XML module ]

The QXmlNamespaceSupport class is a helper class for XML readers which want to include namespace support. More...

`#include <qxml.h>`

List of all member functions.

## Public Members

- QXmlNamespaceSupport ()
- ~QXmlNamespaceSupport ()
- void setPrefix ( const QString &, const QString & )
- QString prefix ( const QString & ) const
- QString uri ( const QString & ) const
- void splitName ( const QString &, QString &, QString & ) const
- void processName ( const QString &, bool, QString &, QString & ) const
- QStringList prefixes () const
- QStringList prefixes ( const QString & ) const
- void pushContext ()
- void popContext ()
- void reset ()

## Detailed Description

The QXmlNamespaceSupport class is a helper class for XML readers which want to include namespace support.

It provides some functions that makes it easy to handle namespaces. Its main use is for subclasses of QXmlReader which want to provide namespace support.

See also the namespace description

## Member Function Documentation

### QXmlNamespaceSupport::QXmlNamespaceSupport ()

Constructs a QXmlNamespaceSupport.

### QXmlNamespaceSupport::~QXmlNamespaceSupport ()

Destructs a QXmlNamespaceSupport.

### void QXmlNamespaceSupport::popContext ()

Reverts to the previous namespace context.

Normally, you should pop the context at the end of each XML element. After popping the context, all namespace prefix mappings that were previously in force are restored.

### QString QXmlNamespaceSupport::prefix ( const QString & uri ) const

Returns one of the prefixes mapped to a namespace URI.

If more than one prefix is currently mapped to the same URI, this function will make an arbitrary selection; if you want all of the prefixes, use the prefixes() function instead.

Note: this will never return the empty (default) prefix; to check for a default prefix, use the uri() function with an argument of "".

### QStringList QXmlNamespaceSupport::prefixes () const

Returns an enumeration of all prefixes currently declared.

Note: if there is a default prefix, it will not be returned in this enumeration; check for the default prefix using uri() with an argument of "".

### QStringList QXmlNamespaceSupport::prefixes ( const QString & uri ) const

Returns a list of all prefixes currently declared for a URI.

The xml: prefix will be included. If you want only one prefix that's mapped to the namespace URI, and you don't care which one you get, use the prefix() function instead.

Note: the empty (default) prefix is never included in this enumeration; to check for the presence of a default namespace, use uri() with an argument of "".

### void QXmlNamespaceSupport::processName ( const QString & qname, bool isAttribute, QString & nsuri, QString & localname ) const

Processes a raw XML 1.0 name in the current context by removing the prefix and looking it up among the prefixes currently declared.

First parameter is the raw XML 1.0 name to be processed. The second parameter is a flag wheter the name is the name of an attribute (TRUE) or not (FALSE).

The return values will be stored in the last two parameters as follows:

- The namespace URI, or an empty string if none is in use.
- The local name (without prefix).

If the raw name has a prefix that has not been declared, then the return value will be empty.

Note that attribute names are processed differently than element names: an unprefixed element name will received the default namespace (if any), while an unprefixed element name will not.

### void QXmlNamespaceSupport::pushContext ()

Starts a new namespace context.

Normally, you should push a new context at the beginning of each XML element: the new context will automatically inherit the declarations of its parent context, but it will also keep track of which declarations were made within this context.

### void QXmlNamespaceSupport::reset ()

Resets this namespace support object for reuse.

### void QXmlNamespaceSupport::setPrefix ( const QString & pre, const QString & uri )

This function declares a prefix in the current namespace context; the prefix will remain in force until this context is popped, unless it is shadowed in a descendant context.

Note that there is an asymmetry in this library: while prefix() will not return the default "" prefix, even if you have declared one; to check for a default prefix, you have to look it up explicitly using uri(). This asymmetry exists to make it easier to look up prefixes for attribute names, where the default prefix is not allowed.

### void QXmlNamespaceSupport::splitName ( const QString & qname, QString & prefix, QString & localname ) const

Splits the name at the ':' and returns the prefix and the local name.

### QString QXmlNamespaceSupport::uri ( const QString & prefix ) const

Looks up a prefix in the current context and returns the currently-mapped namespace URI. Use the empty string ("") for the default namespace.

Search the documentation, FAQ, qt-interest archive and more (uses www.trolltech.com):

This file is part of the Qt toolkit, copyright © 1995-2001 Trolltech, all rights reserved.