Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
JawsMako::IMarkedContentDetails Class Referenceabstract

Details of Marked Content applied to an IDOMGroup. More...

#include <jawsmako/structure.h>

Inheritance diagram for JawsMako::IMarkedContentDetails:
[legend]

Public Member Functions

virtual ~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.
Public Member Functions inherited from JawsMako::IHashable
virtual ~IHashable ()
virtual uint64 hash () const
 Obtain a 64-bit hash of the receiving object.
virtual void updateHash (uint64 &hash) const =0
 Update the given hash to include the receiver.

Static Public Member Functions

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

Details of Marked Content applied to an IDOMGroup.

Constructor & Destructor Documentation

◆ ~IMarkedContentDetails()

virtual JawsMako::IMarkedContentDetails::~IMarkedContentDetails ( )
inlinevirtual

Member Function Documentation

◆ create()

JAWSMAKO_API IMarkedContentDetailsPtr JawsMako::IMarkedContentDetails::create ( const IJawsMakoPtr & jawsMako,
const U8String & tag,
const IRCObjectPtr & properties,
bool isPoint )
static

Create general-purpose 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.
Returns
IMarkedContentDetailsPtr The new marked content details object.

◆ getIsPoint()

virtual bool JawsMako::IMarkedContentDetails::getIsPoint ( ) const
pure virtual

Do the marked content details represent a single point?

Returns
bool True if the marked content is a point, false otherwise.

◆ getProperties()

virtual IPDFObjectPtr JawsMako::IMarkedContentDetails::getProperties ( ) const
pure virtual

Obtain the properties, if present, as a PDF Object. Do not edit this object.

Returns
IPDFObjectPtr The properties of the marked content.

◆ getTag()

virtual U8String JawsMako::IMarkedContentDetails::getTag ( ) const
pure virtual

Obtain the marked content's tag.

Returns
U8String The tag for the marked content.

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