Xalan-C++ API Reference  1.12.0
Public Member Functions | List of all members
xalanc::XalanSourceTreeProcessingInstruction Class Reference

#include <xalanc/XalanSourceTree/XalanSourceTreeProcessingInstruction.hpp>

Inheritance diagram for xalanc::XalanSourceTreeProcessingInstruction:
[legend]
Collaboration diagram for xalanc::XalanSourceTreeProcessingInstruction:
[legend]

Public Member Functions

 XalanSourceTreeProcessingInstruction (const XalanDOMString &theTarget, const XalanDOMString &theData, XalanSourceTreeDocument *theOwnerDocument, XalanNode *theParentNode=0, XalanNode *thePreviousSibling=0, XalanNode *theNextSibling=0, IndexType theIndex=0)
 Create an instance. More...
 
virtual ~XalanSourceTreeProcessingInstruction ()
 
virtual const XalanDOMStringgetNodeName () const
 Gets the name of this node, depending on its type. More...
 
virtual const XalanDOMStringgetNodeValue () const
 Gets the value of this node, depending on its type. More...
 
virtual NodeType getNodeType () const
 An enum value representing the type of the underlying object. More...
 
virtual XalanNodegetParentNode () const
 Gets the parent of this node. More...
 
virtual const XalanNodeListgetChildNodes () const
 Gets a NodeList that contains all children of this node. More...
 
virtual XalanNodegetFirstChild () const
 Gets the first child of this node. More...
 
virtual XalanNodegetLastChild () const
 Gets the last child of this node. More...
 
virtual XalanNodegetPreviousSibling () const
 Gets the node immediately preceding this node. More...
 
virtual XalanNodegetNextSibling () const
 Gets the node immediately following this node. More...
 
virtual const XalanNamedNodeMapgetAttributes () const
 Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. More...
 
virtual XalanDocumentgetOwnerDocument () const
 Gets the Document object associated with this node. More...
 
virtual const XalanDOMStringgetNamespaceURI () const
 Get the namespace URI of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetPrefix () const
 Get the namespace prefix of this node, or null if it is unspecified. More...
 
virtual const XalanDOMStringgetLocalName () const
 Returns the local part of the qualified name of this node. More...
 
virtual bool isIndexed () const
 Determine if the document is node-order indexed. More...
 
virtual IndexType getIndex () const
 Get the node's index. More...
 
virtual const XalanDOMStringgetTarget () const
 The target of this processing instruction. More...
 
virtual const XalanDOMStringgetData () const
 The content of this processing instruction. More...
 
void setParent (XalanSourceTreeElement *theParent)
 
void setParent (XalanSourceTreeDocumentFragment *theParent)
 
void setPreviousSibling (XalanSourceTreeComment *thePreviousSibling)
 
void setPreviousSibling (XalanSourceTreeElement *thePreviousSibling)
 
void setPreviousSibling (XalanSourceTreeProcessingInstruction *thePreviousSibling)
 
void setPreviousSibling (XalanSourceTreeText *thePreviousSibling)
 
void appendSiblingNode (XalanSourceTreeComment *theSibling)
 
void appendSiblingNode (XalanSourceTreeElement *theSibling)
 
void appendSiblingNode (XalanSourceTreeProcessingInstruction *theSibling)
 
void appendSiblingNode (XalanSourceTreeText *theSibling)
 
void setIndex (IndexType theIndex)
 
- Public Member Functions inherited from xalanc::XalanProcessingInstruction
 XalanProcessingInstruction ()
 
virtual ~XalanProcessingInstruction ()
 
- Public Member Functions inherited from xalanc::XalanNode
 XalanNode ()
 
virtual ~XalanNode ()
 

Additional Inherited Members

- Public Types inherited from xalanc::XalanNode
enum  NodeType {
  UNKNOWN_NODE = 0, ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3,
  CDATA_SECTION_NODE = 4, ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7,
  COMMENT_NODE = 8, DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11,
  NOTATION_NODE = 12
}
 
typedef unsigned long IndexType
 
- Protected Member Functions inherited from xalanc::XalanProcessingInstruction
 XalanProcessingInstruction (const XalanProcessingInstruction &theSource)
 
XalanProcessingInstructionoperator= (const XalanProcessingInstruction &theSource)
 
bool operator== (const XalanProcessingInstruction &theRHS) const
 
- Protected Member Functions inherited from xalanc::XalanNode
 XalanNode (const XalanNode &theSource)
 
XalanNodeoperator= (const XalanNode &theSource)
 
bool operator== (const XalanNode &theRHS) const
 

Detailed Description

Definition at line 47 of file XalanSourceTreeProcessingInstruction.hpp.

Constructor & Destructor Documentation

◆ XalanSourceTreeProcessingInstruction()

xalanc::XalanSourceTreeProcessingInstruction::XalanSourceTreeProcessingInstruction ( const XalanDOMString theTarget,
const XalanDOMString theData,
XalanSourceTreeDocument theOwnerDocument,
XalanNode theParentNode = 0,
XalanNode thePreviousSibling = 0,
XalanNode theNextSibling = 0,
IndexType  theIndex = 0 
)

Create an instance.

Parameters
theTargetThe target for the processing instruction.
theDataThe data for the node
theOwnerDocumentThe document that owns the instance.
theParentNodeThe parent node, if any.
thePreviousSiblingThe next sibling, if any.
theNextSiblingThe next sibling, if any.
theIndexThe document-order index of the node.
Returns
pointer to the instance

◆ ~XalanSourceTreeProcessingInstruction()

virtual xalanc::XalanSourceTreeProcessingInstruction::~XalanSourceTreeProcessingInstruction ( )
virtual

Member Function Documentation

◆ appendSiblingNode() [1/4]

void xalanc::XalanSourceTreeProcessingInstruction::appendSiblingNode ( XalanSourceTreeComment theSibling)

◆ appendSiblingNode() [2/4]

void xalanc::XalanSourceTreeProcessingInstruction::appendSiblingNode ( XalanSourceTreeElement theSibling)

◆ appendSiblingNode() [3/4]

void xalanc::XalanSourceTreeProcessingInstruction::appendSiblingNode ( XalanSourceTreeProcessingInstruction theSibling)

◆ appendSiblingNode() [4/4]

void xalanc::XalanSourceTreeProcessingInstruction::appendSiblingNode ( XalanSourceTreeText theSibling)

◆ getAttributes()

virtual const XalanNamedNodeMap* xalanc::XalanSourceTreeProcessingInstruction::getAttributes ( ) const
virtual

Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

Implements xalanc::XalanProcessingInstruction.

◆ getChildNodes()

virtual const XalanNodeList* xalanc::XalanSourceTreeProcessingInstruction::getChildNodes ( ) const
virtual

Gets a NodeList that contains all children of this node.

If there are no children, this is a NodeList containing no nodes. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.

Implements xalanc::XalanProcessingInstruction.

◆ getData()

virtual const XalanDOMString& xalanc::XalanSourceTreeProcessingInstruction::getData ( ) const
virtual

The content of this processing instruction.

This is from the first non white space character after the target to the character immediately preceding the ?>.

Exceptions
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

Implements xalanc::XalanProcessingInstruction.

◆ getFirstChild()

virtual XalanNode* xalanc::XalanSourceTreeProcessingInstruction::getFirstChild ( ) const
virtual

Gets the first child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanProcessingInstruction.

◆ getIndex()

virtual IndexType xalanc::XalanSourceTreeProcessingInstruction::getIndex ( ) const
virtual

Get the node's index.

Valid only if the owner document reports that the document is node-order indexed.

Returns
The index value, or 0 if the node is not indexed.

Implements xalanc::XalanProcessingInstruction.

◆ getLastChild()

virtual XalanNode* xalanc::XalanSourceTreeProcessingInstruction::getLastChild ( ) const
virtual

Gets the last child of this node.

If there is no such node, this returns null.

Implements xalanc::XalanProcessingInstruction.

◆ getLocalName()

virtual const XalanDOMString& xalanc::XalanSourceTreeProcessingInstruction::getLocalName ( ) const
virtual

Returns the local part of the qualified name of this node.

For nodes created with a DOM Level 1 method, such as createElement from the Document interface, it is null.

Implements xalanc::XalanProcessingInstruction.

◆ getNamespaceURI()

virtual const XalanDOMString& xalanc::XalanSourceTreeProcessingInstruction::getNamespaceURI ( ) const
virtual

Get the namespace URI of this node, or null if it is unspecified.

This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.

For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null.

Implements xalanc::XalanProcessingInstruction.

◆ getNextSibling()

virtual XalanNode* xalanc::XalanSourceTreeProcessingInstruction::getNextSibling ( ) const
virtual

Gets the node immediately following this node.

If there is no such node, this returns null.

Implements xalanc::XalanProcessingInstruction.

◆ getNodeName()

virtual const XalanDOMString& xalanc::XalanSourceTreeProcessingInstruction::getNodeName ( ) const
virtual

Gets the name of this node, depending on its type.

Implements xalanc::XalanProcessingInstruction.

◆ getNodeType()

virtual NodeType xalanc::XalanSourceTreeProcessingInstruction::getNodeType ( ) const
virtual

An enum value representing the type of the underlying object.

Implements xalanc::XalanProcessingInstruction.

◆ getNodeValue()

virtual const XalanDOMString& xalanc::XalanSourceTreeProcessingInstruction::getNodeValue ( ) const
virtual

Gets the value of this node, depending on its type.

Implements xalanc::XalanProcessingInstruction.

◆ getOwnerDocument()

virtual XalanDocument* xalanc::XalanSourceTreeProcessingInstruction::getOwnerDocument ( ) const
virtual

Gets the Document object associated with this node.

This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

Implements xalanc::XalanProcessingInstruction.

◆ getParentNode()

virtual XalanNode* xalanc::XalanSourceTreeProcessingInstruction::getParentNode ( ) const
virtual

Gets the parent of this node.

All nodes, except Document, DocumentFragment, and Attr may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, a null Node is returned.

Implements xalanc::XalanProcessingInstruction.

◆ getPrefix()

virtual const XalanDOMString& xalanc::XalanSourceTreeProcessingInstruction::getPrefix ( ) const
virtual

Get the namespace prefix of this node, or null if it is unspecified.

Implements xalanc::XalanProcessingInstruction.

◆ getPreviousSibling()

virtual XalanNode* xalanc::XalanSourceTreeProcessingInstruction::getPreviousSibling ( ) const
virtual

Gets the node immediately preceding this node.

If there is no such node, this returns null.

Implements xalanc::XalanProcessingInstruction.

◆ getTarget()

virtual const XalanDOMString& xalanc::XalanSourceTreeProcessingInstruction::getTarget ( ) const
virtual

The target of this processing instruction.

XML defines this as being the first token following the markup that begins the processing instruction.

Implements xalanc::XalanProcessingInstruction.

◆ isIndexed()

virtual bool xalanc::XalanSourceTreeProcessingInstruction::isIndexed ( ) const
virtual

Determine if the document is node-order indexed.

Returns
true if the document is indexed, otherwise false.

Implements xalanc::XalanProcessingInstruction.

◆ setIndex()

void xalanc::XalanSourceTreeProcessingInstruction::setIndex ( IndexType  theIndex)
inline

Definition at line 167 of file XalanSourceTreeProcessingInstruction.hpp.

◆ setParent() [1/2]

void xalanc::XalanSourceTreeProcessingInstruction::setParent ( XalanSourceTreeDocumentFragment theParent)

◆ setParent() [2/2]

void xalanc::XalanSourceTreeProcessingInstruction::setParent ( XalanSourceTreeElement theParent)

◆ setPreviousSibling() [1/4]

void xalanc::XalanSourceTreeProcessingInstruction::setPreviousSibling ( XalanSourceTreeComment thePreviousSibling)

◆ setPreviousSibling() [2/4]

void xalanc::XalanSourceTreeProcessingInstruction::setPreviousSibling ( XalanSourceTreeElement thePreviousSibling)

◆ setPreviousSibling() [3/4]

void xalanc::XalanSourceTreeProcessingInstruction::setPreviousSibling ( XalanSourceTreeProcessingInstruction thePreviousSibling)

◆ setPreviousSibling() [4/4]

void xalanc::XalanSourceTreeProcessingInstruction::setPreviousSibling ( XalanSourceTreeText thePreviousSibling)

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