lib

KoXml Namespace Reference


Detailed Description

This namespace contains a few convenience functions to simplify code using QDom (when loading OASIS documents, in particular).

To find the child element with a given name, use KoXml::namedItemNS.

To find all child elements with a given name, use QDomElement e; forEachElement( e, parent ) { if ( e.localName() == "..." && e.namespaceURI() == KoXmlNS::... ) { ... } } Note that this means you don't ever need to use QDomNode nor toElement anymore! Also note that localName is the part without the prefix, this is the whole point of namespace-aware methods.

To find the attribute with a given name, use QDomElement::attributeNS.

Do not use getElementsByTagNameNS, it's recursive (which is never needed in KOffice). Do not use tagName() or nodeName() or prefix(), since the prefix isn't fixed.

Author:
David Faure <faure@kde.org>


Functions

KoXmlElement namedItemNS (const KoXmlNode &node, const char *nsURI, const char *localName)
void load (KoXmlNode &node, int depth=1)
void unload (KoXmlNode &node)

Function Documentation

KOFFICECORE_EXPORT void KoXml::load KoXmlNode node,
int  depth = 1
 

Explicitly load child nodes of specified node, up to given depth.

This function has no effect if QDom is used.

Definition at line 1548 of file KoXmlReader.cpp.

KOFFICECORE_EXPORT KoXmlElement KoXml::namedItemNS const KoXmlNode node,
const char *  nsURI,
const char *  localName
 

A namespace-aware version of QDomNode::namedItem(), which also takes care of casting to a QDomElement.

Use this when a domelement is known to have only *one* child element with a given tagname.

Note: do *NOT* use getElementsByTagNameNS, it's recursive!

Definition at line 1531 of file KoXmlReader.cpp.

KOFFICECORE_EXPORT void KoXml::unload KoXmlNode node  ) 
 

Unload child nodes of specified node.

This function has no effect if QDom is used.

Definition at line 1560 of file KoXmlReader.cpp.

KDE Home | KDE Accessibility Home | Description of Access Keys