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

A child of a structure element that points to a piece of marked content. Note; to create these, please see IStructureElement::createMarkedContentReferencePair() More...

#include <structure.h>

Inheritance diagram for JawsMako::IStructureMarkedContentReferenceChild:

Public Member Functions

virtual bool matches (const IStructureElementPtr &parentElement, const IMarkedContentStructureDetailsPtr &details) const =0
 Check to see if the given IMarkedContentStructureDetails object matches this reference. That is, does this child refer to a group with these details. Pass in the parent structure element; it is needed to check that the values match.
 
- 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. Note; to create these, please see IStructureElement::createMarkedContentReferencePair()

Member Function Documentation

◆ matches()

virtual bool JawsMako::IStructureMarkedContentReferenceChild::matches ( const IStructureElementPtr & parentElement,
const IMarkedContentStructureDetailsPtr & details ) const
pure virtual

Check to see if the given IMarkedContentStructureDetails object matches this reference. That is, does this child refer to a group with these details. Pass in the parent structure element; it is needed to check that the values match.

Parameters
parentElementThe parent structure element of this child.
detailsThe marked content structure details to check against.
Returns
bool True if the details match, false otherwise.

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