xmltooling 3.0.1

xmltooling::Namespace Class Reference

A data structure for encapsulating XML Namespace attributes. More...

#include <xmltooling/Namespace.h>

List of all members.

Public Types

enum  namespace_usage_t { Indeterminate, NonVisiblyUsed, VisiblyUsed }
 

Tri-state indicator of namespace usage.


Public Member Functions

 Namespace (const XMLCh *uri=nullptr, const XMLCh *prefix=nullptr, bool alwaysDeclare=false, namespace_usage_t usage=Indeterminate)
 Constructor.
const XMLCh * getNamespacePrefix () const
 Returns the namespace prefix.
const XMLCh * getNamespaceURI () const
 Returns the namespace URI.
const bool alwaysDeclare () const
 Returns true iff the namespace should always be declared regardless of in-scope declarations.
const namespace_usage_t usage () const
 Returns the usage of the namespace by an XMLObject.
void setNamespacePrefix (const XMLCh *prefix)
 Sets the namespace prefix.
void setNamespaceURI (const XMLCh *uri)
 Sets the namespace URI.
void setAlwaysDeclare (bool alwaysDeclare)
 Sets the alwaysDeclared property.
void setUsage (namespace_usage_t usage)
 Sets the usage property.

Detailed Description

A data structure for encapsulating XML Namespace attributes.


Constructor & Destructor Documentation

xmltooling::Namespace::Namespace ( const XMLCh *  uri = nullptr,
const XMLCh *  prefix = nullptr,
bool  alwaysDeclare = false,
namespace_usage_t  usage = Indeterminate 
)

Constructor.

Parameters:
urinamespace URI
prefixnamespace prefix (without the colon)
alwaysDeclaretrue iff the namespace should always be declared regardless of in-scope declarations
usageindicates usage of namespace in the context of an XMLObject

Member Function Documentation

const bool xmltooling::Namespace::alwaysDeclare ( ) const [inline]

Returns true iff the namespace should always be declared regardless of in-scope declarations.

Returns:
the alwaysDeclared setting
const XMLCh* xmltooling::Namespace::getNamespacePrefix ( ) const [inline]

Returns the namespace prefix.

Returns:
Null-terminated Unicode string containing the prefix, without the colon
const XMLCh* xmltooling::Namespace::getNamespaceURI ( ) const [inline]

Returns the namespace URI.

Returns:
Null-terminated Unicode string containing the URI
void xmltooling::Namespace::setAlwaysDeclare ( bool  alwaysDeclare) [inline]

Sets the alwaysDeclared property.

Parameters:
alwaysDeclaretrue iff the namespace should always be declared regardless of in-scope declarations
void xmltooling::Namespace::setNamespacePrefix ( const XMLCh *  prefix)

Sets the namespace prefix.

Parameters:
prefixNull-terminated Unicode string containing the prefix, without the colon
void xmltooling::Namespace::setNamespaceURI ( const XMLCh *  uri)

Sets the namespace URI.

Parameters:
uriNull-terminated Unicode string containing the URI
void xmltooling::Namespace::setUsage ( namespace_usage_t  usage) [inline]

Sets the usage property.

Parameters:
usageusage of the namespace by an XMLObject
const namespace_usage_t xmltooling::Namespace::usage ( ) const [inline]

Returns the usage of the namespace by an XMLObject.

Returns:
the usage setting

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