Mako 8.1.0 API
Loading...
Searching...
No Matches
JawsMako::IStructureObjectReferenceChild Class Referenceabstract

A child of a structure element that points to a piece of marked content. These cannot be created directly. Instead, use IStructureElement::appendObjectReferenceChild() or IStructureElement::insertObjectReferenceChild() More...

#include <structure.h>

Inheritance diagram for JawsMako::IStructureObjectReferenceChild:

Public Member Functions

virtual bool matches (const IDOMFormPtr &form) const =0
 Check to see if the given IDOMForm is pointed to by this object reference.
 
- Public Member Functions inherited from JawsMako::IStructureElementChild
virtual eStructureChildType getType () const =0
 Get the type of this child.
 
virtual IStructureElementChildPtr clone () const =0
 Clone the element child.
 
- 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.
 

Additional Inherited Members

- Public Types inherited from JawsMako::IStructureElementChild
enum  eStructureChildType { eSCTStructureElement , eSCTMarkedContentReference , eSCTObjectReference }
 Types for children of structure elements. More...
 
typedef enum JawsMako::IStructureElementChild::eStructureChildType eStructureChildType
 Types for children of structure elements.
 
- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

A child of a structure element that points to a piece of marked content. These cannot be created directly. Instead, use IStructureElement::appendObjectReferenceChild() or IStructureElement::insertObjectReferenceChild()

Member Function Documentation

◆ matches()

virtual bool JawsMako::IStructureObjectReferenceChild::matches ( const IDOMFormPtr & form) const
pure virtual

Check to see if the given IDOMForm is pointed to by this object reference.

Parameters
formThe IDOMForm to check against.
Returns
bool True if the form matches this object reference, false otherwise.

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