Separatista
Separatista::BranchElement Class Reference

#include <branchelement.h>

Inheritance diagram for Separatista::BranchElement:
Separatista::Element Separatista::SeparatistaDocument

Public Member Functions

IOErrorCode toDOMDocument (xercesc::DOMDocument *pDocument, xercesc::DOMElement *pParent, const ErrorOptions errorOptions=ThrowExceptions) const
 
void fromDOMDocument (xercesc::DOMElement *pDOMElement, const ErrorOptions errorOptions=ThrowExceptions)
 
ElementgetElementByTag (const wchar_t *pTagName, size_t nIndex=0) const
 
ElementcreateElementByTag (const wchar_t *pTagName, size_t nIndex=0)
 
TagKeyRange getAllByTagName (const wchar_t *pTagName)
 
void destroyElement (Element *pElement)
 
- Public Member Functions inherited from Separatista::Element
const ElementDescriptorgetElementDescriptor () const
 
void addElementListener (ElementListener *pElementListener)
 
void removeElementListener (ElementListener *pElementListener)
 
const wchar_t * getTag () const
 
virtual const wchar_t * getTextValue () const
 
virtual void setValue (const wchar_t *pValue, const ErrorOptions errorOptions=ThrowExceptions)
 
virtual const wchar_t * getAttributeValue (const wchar_t *pAttributeName) const
 
virtual void setAttributeValue (const wchar_t *pAttributeName, const wchar_t *pValue)
 
time_t getDateValue () const
 
void setValue (const time_t Value, bool bWithTime=false, const ErrorOptions errorOptions=ThrowExceptions)
 
int getIntValue () const
 
void setValue (const int Value, const ErrorOptions errorOptions=ThrowExceptions)
 
double getDoubleValue () const
 
void setValue (const double d, const ErrorOptions errorOptions=ThrowExceptions)
 
bool isEmpty () const
 

Static Public Member Functions

static ElementcreateElement (const ChildElementDescriptor *pChildElementDescriptor)
 

Protected Member Functions

 BranchElement (const ChildElementDescriptor *pChildElementDescriptor)
 
- Protected Member Functions inherited from Separatista::Element
 Element (const ChildElementDescriptor *pChildElementDescriptor)
 
virtual ~Element ()
 
ElementgetParentElement () const
 
void onElementValueChanged (const wchar_t *pNewValue)
 Calls a registered ElementListener's elementValueChanged.
 
void onElementCreated (Element *pChildElement)
 Calls a registered ElementListener's elementCreated.
 
void onElementDeleted ()
 Calls a registered ElementListener's elementDeleted.
 

Additional Inherited Members

- Public Types inherited from Separatista::Element
enum  ErrorOptions { ThrowExceptions = 0, ClearValue, AcceptValue }
 
typedef std::map< const TagKey, Element * > TagKeyMap
 
- Static Protected Member Functions inherited from Separatista::Element
static void deleteElement (Element *pChildElement)
 

Detailed Description

BranchElements are elements that hold child elements.

Member Function Documentation

◆ createElement()

Element * BranchElement::createElement ( const ChildElementDescriptor pChildElementDescriptor)
static

Creates the element from it's descriptor

◆ createElementByTag()

Element * BranchElement::createElementByTag ( const wchar_t *  pTagName,
size_t  nIndex = 0 
)
virtual

◆ destroyElement()

void BranchElement::destroyElement ( Element pElement)
virtual
See also
Element::destroyElement

Reimplemented from Separatista::Element.

◆ fromDOMDocument()

void BranchElement::fromDOMDocument ( xercesc::DOMElement *  pDOMElement,
const ErrorOptions  errorOptions = ThrowExceptions 
)
virtual

Tries to load it's value from the document element.

Parameters
DocumentIteratorThe document iterator to call to continue reading or get value from.

Implements Separatista::Element.

◆ getAllByTagName()

BranchElement::TagKeyRange BranchElement::getAllByTagName ( const wchar_t *  pTagName)
virtual
See also
Element::getAllByTagName

Reimplemented from Separatista::Element.

◆ getElementByTag()

Element * BranchElement::getElementByTag ( const wchar_t *  pTagName,
size_t  nIndex = 0 
) const
virtual
See also
Element::getElementByTag

Reimplemented from Separatista::Element.

◆ toDOMDocument()

IOErrorCode BranchElement::toDOMDocument ( xercesc::DOMDocument *  pDOMDocument,
xercesc::DOMElement *  pDOMParent,
const ErrorOptions  errorOptions = ThrowExceptions 
) const
virtual

Abstract method to call to write an element to a DOMDocument.

Parameters
pDocumentThe DOMDocument to create the element for.
pParentThe DOMElement to append the element to.
Returns
Pointer to the new created DOMElement, or NULL
See also
createElement

Implements Separatista::Element.

Reimplemented in Separatista::SeparatistaDocument.


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