JawsMako::IStructure Class Reference

Top level tracking structure describing the logical structure of the document. More...

#include <structure.h>

Inheritance diagram for JawsMako::IStructure:

Public Member Functions
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.
Public Member Functions inherited from IRCObject
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 Public Member Functions
static JAWSMAKO_API IStructurePtr	create (const IJawsMakoPtr &jawsMako)
	Create a new Structure.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Top level tracking structure describing the logical structure of the document.

Member Function Documentation

appendElement()

virtual void JawsMako::IStructure::appendElement ( const IStructureElementPtr & element )

pure virtual

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.

Parameters

element

The structure element to add.

clone()

virtual IStructurePtr JawsMako::IStructure::clone ( ) const

pure virtual

Perform a deep clone of the structure.

Returns

IStructurePtr A new structure that is a deep clone of this one.

create()

static JAWSMAKO_API IStructurePtr JawsMako::IStructure::create ( const IJawsMakoPtr & jawsMako )

static

Create a new Structure.

Parameters

jawsMako

The IJawsMako object.

Returns

IStructurePtr The new structure.

findStructureElementWithReference()

virtual IStructureElementPtr JawsMako::IStructure::findStructureElementWithReference ( const IStructureElementReferencePtr & reference ) const

pure virtual

Find the structure element matching the given reference, or NULL if it does not exist.

Parameters

reference

The structure element reference to find.

Returns

IStructureElementPtr The structure element matching the reference.

getChildElements()

virtual const CStructureElementVect & JawsMako::IStructure::getChildElements ( ) const

pure virtual

Get the child structure elements.

Returns

CStructureElementVect The vector of child structure elements.

insertElement()

virtual void JawsMako::IStructure::insertElement ( const IStructureElementPtr & element, uint32 index )

pure virtual

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.

Parameters

element	The structure element to insert.
index	The index at which to insert the element, where 0 is the head.

removeElement()

virtual void JawsMako::IStructure::removeElement ( uint32 index )

pure virtual

Remove the element at the given index from the list of children. Note: This will also cause all child elements to be removed.

Parameters

index

The index of the element to remove, where 0 is the head.

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.

Parameters

element	The structure element to tag the node with.
page	The page on which the node resides.
nodeToTag	The node to tag with the structure element.

Returns

IDOMNodePtr The tagged node, which may be the same as the input node,

---

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

• structure.h