NiXPSObjects::NOContentStreamNavigator Class Reference
#include "NOContentStreamNavigator.h"
List of all members.
Detailed Description
Use an NOContentStreamNavigator to navigate and manipulate an XML content stream
Member Function Documentation
bool NiXPSObjects::NOContentStreamNavigator::addAttribute |
( |
const NCommon::UTF8Char * |
pKey, |
|
|
const NCommon::UTF8Char * |
pValue | |
|
) |
| | |
Adds an attribute to the current node
- Parameters:
-
| pAttributeName | The name of the attribute to set the value of |
| pValue | The string to set the attribute value to |
const NCommon::UTF8String NiXPSObjects::NOContentStreamNavigator::getAttributeValue |
( |
const NCommon::UTF8Char * |
pAttributeName |
) |
const |
Get the value of an attribute of the current node
- Parameters:
-
| pAttributeName | The name of the attribute to get the value of |
- Returns:
- The value of the attribute as a (const) UTF8String
Get Position and Length of the current node
- Parameters:
-
| lPos | On return, the position of the current node |
| lLen | On return, the length of the current node |
bool NiXPSObjects::NOContentStreamNavigator::hasAttributeValue |
( |
const NCommon::UTF8Char * |
pAttributeName |
) |
const |
Test for the presence of the given attribute
- Parameters:
-
| pAttributeName | The attribute name to test for |
Inserts XML at the cursor of another content stream navigator as a child of the node at the cursor of this content stream navigator
- Parameters:
-
| pNav | the content stream navigator pointing to the XML node to insert as a child in the current content stream |
- Returns:
- Whether the operation was successful
bool NiXPSObjects::NOContentStreamNavigator::insertAsChild |
( |
const NCommon::UTF8Char * |
pXML |
) |
|
Inserts XML as a child of the current node
- Parameters:
-
| pXML | The XML to insert as a UTF8String |
- Returns:
- Whether the operation was successful
bool NiXPSObjects::NOContentStreamNavigator::insertChild |
( |
const NCommon::UTF8Char * |
pName, |
|
|
NCommon::UInt32 |
pPosition, |
|
|
bool |
pToChild | |
|
) |
| | |
Inserts a child in the current node
- Parameters:
-
| pName | The name of the element as a UTF8String |
| pPosition | The position of this inserted element |
| pToChild | Navigate to this freshly created child, or not |
- Returns:
- Whether the operation was successful
bool NiXPSObjects::NOContentStreamNavigator::setAttributeValue |
( |
const NCommon::UTF8Char * |
pAttributeName, |
|
|
const NCommon::UTF8Char * |
pValue | |
|
) |
| | |
Set the value of an attribute in the current node
- Parameters:
-
| pAttributeName | The name of the attribute to set the value of |
| pValue | The string to set the attribute value to |
bool NiXPSObjects::NOContentStreamNavigator::toAttributeValue |
( |
const NCommon::UTF8Char * |
pAttributeName |
) |
|
Navigate to the attribute value
- Parameters:
-
| pAttributeName | The name of the attribute to set the value of |
bool NiXPSObjects::NOContentStreamNavigator::toChild |
( |
const NCommon::UTF8Char * |
pString, |
|
|
const bool |
pCaseSensitive = true , |
|
|
const bool |
pIgnorePrefix = true | |
|
) |
| | |
Navigate to child node with given name, optionally ingnoring case and/or namespace
- Parameters:
-
| pString | The name of the node to go to |
| pCaseSensitive | Behave case sensitive. Defaults to true (case sensitive) |
| pIgnorePrefix | Ignore namespace prefixes. Defaults to true (ignore namespace prefixes) |
bool NiXPSObjects::NOContentStreamNavigator::toChild |
( |
const NCommon::UInt32 |
pNum |
) |
|
Navigate to child node at given index
- Parameters:
-
| pNum | the index of the node to navigate to |
Navigates the stream to the object with given ID
- Parameters:
-
bool NiXPSObjects::NOContentStreamNavigator::toParent |
( |
|
) |
|
Navigate to parent
- Returns:
- True upon success, false if there is no parent
bool NiXPSObjects::NOContentStreamNavigator::toSibling |
( |
|
) |
|
Navigate to next sibling
- Returns:
- True upon success, false if there is no next sibling
The documentation for this class was generated from the following files: