Main Page   Class Hierarchy   Data Structures   File List   Data Fields   Globals  

OfxGenericContainer Class Reference

A generic container for an OFX SGML element. Every container inherits from OfxGenericContainer. More...

Inheritance diagram for OfxGenericContainer:

OfxAccountContainer OfxAccountContainer OfxBalanceContainer OfxBalanceContainer OfxDummyContainer OfxDummyContainer OfxMainContainer OfxMainContainer OfxPushUpContainer OfxPushUpContainer OfxSecurityContainer OfxSecurityContainer OfxStatementContainer OfxStatementContainer OfxStatusContainer OfxStatusContainer OfxTransactionContainer OfxTransactionContainer

Public Methods

 OfxGenericContainer ()
 OfxGenericContainer (OfxGenericContainer *para_parentcontainer)
 OfxGenericContainer (OfxGenericContainer *para_parentcontainer, string para_tag_identifier)
virtual ~OfxGenericContainer ()
virtual void add_attribute (const string identifier, const string value)
 Add data to a container object. More...

virtual int gen_event ()
 Generate libofx.h events. More...

virtual int add_to_main_tree ()
 Add this container to the main tree. More...

OfxGenericContainer * getparent ()
 Returns the parent container object (the one representing the containing OFX SGML element).

 OfxGenericContainer ()
 OfxGenericContainer (OfxGenericContainer *para_parentcontainer)
 OfxGenericContainer (OfxGenericContainer *para_parentcontainer, string para_tag_identifier)
virtual ~OfxGenericContainer ()
virtual void add_attribute (const string identifier, const string value)
 Add data to a container object. More...

virtual int gen_event ()
 Generate libofx.h events. More...

virtual int add_to_main_tree ()
 Add this container to the main tree. More...

OfxGenericContainer * getparent ()
 Returns the parent container object (the one representing the containing OFX SGML element).


Data Fields

string type
string tag_identifier
OfxGenericContainer * parentcontainer
OfxGenericContainer * parentcontainer

Detailed Description

A generic container for an OFX SGML element. Every container inherits from OfxGenericContainer.

A hierarchy of containers is built as the file is parsed. The supported OFX elements all have a matching container. The others are assigned a OfxDummyContainer, so every OFX element creates a container as the file is par Note however that containers are destroyed as soon as the corresponding SGML element is closed.

Definition at line 31 of file ofx_containers.hh.


Member Function Documentation

virtual void OfxGenericContainer::add_attribute const string    identifier,
const string    value
[virtual]
 

Add data to a container object.

Must be called once completed parsing an OFX SGML data element. The parent container should know what to do with it.

Parameters:
identifier  The name of the data element
value  The concatenated string of the data

Reimplemented in OfxDummyContainer.

void OfxGenericContainer::add_attribute const string    identifier,
const string    value
[virtual]
 

Add data to a container object.

Must be called once completed parsing an OFX SGML data element. The parent container should know what to do with it.

Parameters:
identifier  The name of the data element
value  The concatenated string of the data

Reimplemented in OfxDummyContainer.

Definition at line 52 of file ofx_container_generic.cpp.

Referenced by OfxBalanceContainer::add_attribute, OfxStatusContainer::add_attribute, OfxPushUpContainer::add_attribute, OfxTransactionContainer::add_attribute, OfxStatementContainer::add_attribute, OfxSecurityContainer::add_attribute, OfxAccountContainer::add_attribute, and OutlineApplication::endElement.

virtual int OfxGenericContainer::add_to_main_tree   [virtual]
 

Add this container to the main tree.

add_to_main_treegen_event will add the container to the main trees stored int the OfxMainContainer.

Returns:
true if successfull, false otherwise.

Reimplemented in OfxStatementContainer.

int OfxGenericContainer::add_to_main_tree   [virtual]
 

Add this container to the main tree.

add_to_main_treegen_event will add the container to the main trees stored int the OfxMainContainer.

Returns:
true if successfull, false otherwise.

Reimplemented in OfxStatementContainer.

Definition at line 69 of file ofx_container_generic.cpp.

Referenced by OutlineApplication::endElement.

virtual int OfxGenericContainer::gen_event   [virtual]
 

Generate libofx.h events.

gen_event will call the appropriate ofx_proc_XXX_cb defined in libofx.h if one is available.

Returns:
true if a callback function vas called, false otherwise.

Reimplemented in OfxStatementContainer.

int OfxGenericContainer::gen_event   [virtual]
 

Generate libofx.h events.

gen_event will call the appropriate ofx_proc_XXX_cb defined in libofx.h if one is available.

Returns:
true if a callback function vas called, false otherwise.

Reimplemented in OfxStatementContainer.

Definition at line 63 of file ofx_container_generic.cpp.


Field Documentation

string OfxGenericContainer::tag_identifier
 

The identifer of the creating tag

Definition at line 34 of file fx-0.6.2/lib/ofx_containers.hh.

Referenced by OfxDummyContainer::add_attribute, and OutlineApplication::endElement.

string OfxGenericContainer::type
 

The type of the object, often == tag_identifier

Definition at line 33 of file fx-0.6.2/lib/ofx_containers.hh.

Referenced by OfxStatusContainer::add_attribute, add_attribute, OutlineApplication::endElement, and OutlineApplication::startElement.


The documentation for this class was generated from the following files:
Generated on Sun Nov 24 20:26:32 2002 for LibOFX by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002