API
JawsMako::IStructureElement Class Referenceabstract

A structure element in the structure tree. More...

#include <structure.h>

Inheritance diagram for JawsMako::IStructureElement:

Public Member Functions

virtual IStructureElementPtr clone () const =0
 Obtain a clone of the element.
 
virtual U8String getStructureType () const =0
 Get the structure type.
 
virtual void setStructureType (const U8String &structureType)=0
 Set the structure type. Must be non-zero length.
 
virtual void setTitle (const U8String &title)=0
 Set the "Title" of the structure element, or an empty string to remove.
 
virtual U8String getLanguage () const =0
 Get the language specifier for this element, or an empty string if none is specified.
 
virtual void setLanguage (const U8String &language)=0
 Set the language specifier for this element, or an empty string to remove.
 
virtual U8String getAlternate () const =0
 Get the alternate description of the structure element, in human readable form. Returns an empty string if none is provided.
 
virtual void setAlternate (const U8String &alternateDescription)=0
 Set the alternate description of the structure element, or an empty string to remove.
 
virtual U8String getActualText () const =0
 Get the actual text of the structure element. Returns an empty string if none is provided.
 
virtual void setActualText (const U8String &actualText)=0
 Set the alternate description of the structure element, or an empty string to remove.
 
virtual void appendElement (const IStructurePtr &structure, const IStructureElementPtr &element)=0
 Add an element to the end of the children. An exception will be thrown if the element already exists in the structure tree. The structure containing the target element must be provided.
 
virtual void insertElement (const IStructurePtr &structure, const IStructureElementPtr &element, uint32 index)=0
 Insert an element at the given index, where 0 is the head. An exception will be thrown if an element is added that already exists in the structure tree.
 
virtual void appendMarkedContentReferenceChild (const IStructureMarkedContentReferenceChildPtr &child)=0
 Add a marked content reference to the end of the children.
 
virtual void insertMarkedContentReferenceChild (const IStructureMarkedContentReferenceChildPtr &child, uint32 index)=0
 Insert a marked content reference into the children at the given index, where an index of 0 is the head.
 
virtual void appendObjectReferenceChild (const IPagePtr &page, const IDOMFormPtr &targetForm)=0
 Add an object reference targetting the given form to the end of the chidren. In some situations the form may have its properties edited. Pass in the page (required) that the form will appear on.
 
virtual void insertObjectReferenceChild (const IPagePtr &page, const IDOMFormPtr &targetForm, uint32 index)=0
 Insert an object reference targetting the given form into the children at the given index, where 0 is the head. In some situations the form may have its properties edited. Pass in the page (required) that the form will appear on.
 
virtual void removeChild (const IStructurePtr &structure, uint32 index)=0
 Remove the child at the given index from the list of children. Note: This will also cause all child elements of that element to be removed.
 
virtual void createMarkedContentReferencePair (const IStructurePtr &structure, const IPagePtr &page, const IDOMNodePtr &node, IStructureMarkedContentReferenceChildPtr &resultReference, IMarkedContentStructureDetailsPtr &resultDetails)=0
 Create a IStructureMarkedContentReferenceChild and an IMarkedContentStructureDetails pair for a node present on a given page. Cannot be used with form nodes. Neither the node nor the target element are edited, but in some situations the parents of the node may have their properties edited. More...
 
virtual const CStructureElementChildVect & getChildren () const =0
 Get the child structure information.
 
virtual IStructureElementReferencePtr getStructureElementReference () const =0
 Obtain a reference for the structure element.
 
virtual IStructureElementPtr findStructureElementWithReference (const IStructureElementReferencePtr &reference) const =0
 Find the structure element matching the given reference, in the children. Returns NULL if it does not exist.
 
- Public Member Functions inherited from IRCObject
virtual void addRef ()=0
 Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
 
virtual bool decRef ()=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. More...
 

Static Public Member Functions

static JAWSMAKO_API IStructureElementPtr create (const IJawsMakoPtr &jawsMako, const U8String &structureType)
 Create a structure element.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

A structure element in the structure tree.

Member Function Documentation

◆ createMarkedContentReferencePair()

virtual void JawsMako::IStructureElement::createMarkedContentReferencePair ( const IStructurePtr &  structure,
const IPagePtr &  page,
const IDOMNodePtr &  node,
IStructureMarkedContentReferenceChildPtr &  resultReference,
IMarkedContentStructureDetailsPtr &  resultDetails 
)
pure virtual

Create a IStructureMarkedContentReferenceChild and an IMarkedContentStructureDetails pair for a node present on a given page. Cannot be used with form nodes. Neither the node nor the target element are edited, but in some situations the parents of the node may have their properties edited.

See also IStructure::tagNode() for a simplified method for applying structure to an individual node.


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