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

A subclass of IMarkedContentDetails that is created when the marked content is associated with the document's structure. More...

#include <structure.h>

Inheritance diagram for JawsMako::IMarkedContentStructureDetails:

Public Member Functions

virtual IStructureElementReferencePtr getStructureElementReference () const =0
 Obtain a reference for the structure element that this content refers to. Will never return NULL.
 
- Public Member Functions inherited from JawsMako::IMarkedContentDetails
virtual U8String getTag () const =0
 Obtain the marked content's tag.
 
virtual IPDFObjectPtr getProperties () const =0
 Obtain the properties, if present, as a PDF Object. Do not edit this object.
 
virtual bool getIsPoint () const =0
 Do the marked content details represent a single point?
 
- 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 IMarkedContentStructureDetailsPtr create (const IJawsMakoPtr &jawsMako, const U8String &tag, const IRCObjectPtr &properties, bool isPoint, const IStructureElementReferencePtr &elementReference)
 Create structure marked content details.
 
- Static Public Member Functions inherited from JawsMako::IMarkedContentDetails
static JAWSMAKO_API IMarkedContentDetailsPtr create (const IJawsMakoPtr &jawsMako, const U8String &tag, const IRCObjectPtr &properties, bool isPoint)
 Create general-purpose marked content details.
 

Additional Inherited Members

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

Detailed Description

A subclass of IMarkedContentDetails that is created when the marked content is associated with the document's structure.

Member Function Documentation

◆ create()

static JAWSMAKO_API IMarkedContentStructureDetailsPtr JawsMako::IMarkedContentStructureDetails::create ( const IJawsMakoPtr & jawsMako,
const U8String & tag,
const IRCObjectPtr & properties,
bool isPoint,
const IStructureElementReferencePtr & elementReference )
static

Create structure marked content details.

Parameters
jawsMakoThe IJawsMako object.
tagThe tag for the marked content.
propertiesThe properties, if any, as a PDF Object.
isPointWhether the marked content represents a single point.
elementReferenceThe reference to the structure element that this content refers to.
Returns
IMarkedContentStructureDetailsPtr The new marked content structure details object.

◆ getStructureElementReference()

virtual IStructureElementReferencePtr JawsMako::IMarkedContentStructureDetails::getStructureElementReference ( ) const
pure virtual

Obtain a reference for the structure element that this content refers to. Will never return NULL.

Returns
IStructureElementReferencePtr The structure element reference.

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