JawsMako::IMarkedContentArtifactDetails Class Reference

A subclass of IMarkedContentDetails that is created when the content is a logical structure Artifact. More...

#include <jawsmako/structure.h>

Inheritance diagram for JawsMako::IMarkedContentArtifactDetails:

Public Member Functions
virtual	~IMarkedContentArtifactDetails ()
virtual U8String	getType () const =0
	Get the type of the artifact, if present. Returns an empty string if no Type information is provided.
virtual U8String	getSubtype () const =0
	Get the subtype of the artifact, if present. Returns an empty string if no Type information is provided.
Public Member Functions inherited from JawsMako::IMarkedContentDetails
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 IMarkedContentArtifactDetailsPtr	create (const IJawsMakoPtr &jawsMako, const U8String &tag, const IRCObjectPtr &properties, bool isPoint)
	Basic marked content artifact details creation.
static JAWSMAKO_API IMarkedContentArtifactDetailsPtr	create (const IJawsMakoPtr &jawsMako, const U8String &type, const U8String &subType)
	Create marked content details for a logical structure Artifact In this context, an artifact is any object that are not relevant for the understanding of the content.
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 content is a logical structure Artifact.

Constructor & Destructor Documentation

~IMarkedContentArtifactDetails()

virtual JawsMako::IMarkedContentArtifactDetails::~IMarkedContentArtifactDetails ( )

inlinevirtual

Member Function Documentation

create() [1/2]

JAWSMAKO_API IMarkedContentArtifactDetailsPtr JawsMako::IMarkedContentArtifactDetails::create ( const IJawsMakoPtr & jawsMako, const U8String & tag, const IRCObjectPtr & properties, bool isPoint )

static

Basic marked content artifact details creation.

Parameters

jawsMako	The IJawsMako object.
tag	The tag for the marked content.
properties	The properties, if any, as a PDF Object.
isPoint	Whether the marked content represents a single point.

Returns

IMarkedContentArtifactDetailsPtr The new marked content artifact details object.

create() [2/2]

JAWSMAKO_API IMarkedContentArtifactDetailsPtr JawsMako::IMarkedContentArtifactDetails::create ( const IJawsMakoPtr & jawsMako, const U8String & type, const U8String & subType )

static

Create marked content details for a logical structure Artifact In this context, an artifact is any object that are not relevant for the understanding of the content.

Parameters

jawsMako	The IJawsMako object.
type	The type of the artifact, such as "Figure", "Table", etc.
subType	The subtype of the artifact, such as "Figure 1", "Table 2", etc.

Returns

IMarkedContentArtifactDetailsPtr The new marked content artifact details object.

getSubtype()

virtual U8String JawsMako::IMarkedContentArtifactDetails::getSubtype ( ) const

pure virtual

Get the subtype of the artifact, if present. Returns an empty string if no Type information is provided.

Returns

U8String The subtype of the artifact, such as "Figure 1", "Table 2", etc.

getType()

virtual U8String JawsMako::IMarkedContentArtifactDetails::getType ( ) const

pure virtual

Get the type of the artifact, if present. Returns an empty string if no Type information is provided.

Returns

U8String The type of the artifact, such as "Figure", "Table", etc.

---

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

• jawsmako/structure.h