Top level tracking structure describing the logical structure of the document.
More...
#include <structure.h>
|
|
virtual IStructurePtr | clone () const =0 |
| | Perform a deep clone of the structure.
|
| |
| virtual IDOMNodePtr | tagNode (const IStructureElementPtr &element, const IPagePtr &page, const IDOMNodePtr &nodeToTag)=0 |
| | Tag an IDOMNode from the given page with the given element.
|
| |
|
virtual void | appendElement (const IStructureElementPtr &element)=0 |
| | Add an element to the end of the children at the top level. An exception will be thrown if the element already exists in the structure tree.
|
| |
|
virtual void | insertElement (const IStructureElementPtr &element, uint32 index)=0 |
| | Insert an element into the children at the top level at the given index, where an index of 0 is the head of the list. An exception will be thrown if the element already exists in the structure tree.
|
| |
|
virtual void | removeElement (uint32 index)=0 |
| | Remove the element at the given index from the list of children. Note: This will also cause all child elements to be removed.
|
| |
|
virtual const CStructureElementVect & | getChildElements () const =0 |
| | Get the child structure elements.
|
| |
|
virtual IStructureElementPtr | findStructureElementWithReference (const IStructureElementReferencePtr &reference) const =0 |
| | Find the structure element matching the given reference, or NULL if it does not exist.
|
| |
|
virtual void | addRef () const =0 |
| | Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
|
| |
| virtual bool | decRef () const =0 |
| | Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
|
| |
| virtual int32 | getRefCount () const =0 |
| | Retrieve the current reference count of the actual object pointed to.
|
| |
|
|
static JAWSMAKO_API IStructurePtr | create (const IJawsMakoPtr &jawsMako) |
| | Create a new Structure.
|
| |
|
|
virtual | ~IRCObject () |
| | Virtual destructor.
|
| |
Top level tracking structure describing the logical structure of the document.
◆ tagNode()
| virtual IDOMNodePtr JawsMako::IStructure::tagNode |
( |
const IStructureElementPtr & | element, |
|
|
const IPagePtr & | page, |
|
|
const IDOMNodePtr & | nodeToTag ) |
|
pure virtual |
Tag an IDOMNode from the given page with the given element.
If the node is an IDOMGroup (which isn't already optional content or
tagged with structure information) or IDOMForm, the node will have
it's marked content information set accordingly and the returned result
will be that node.
However, if the node is some other graphical node, it will be moved
inside an IDOMGroup with the optional content information set. If the
node is in a tree, the node will be replaced with the group. The
group will be returned.
The given element must be present in the structure.
The documentation for this class was generated from the following file:
Public Member Functions inherited from IRCObject