A generic interface class for a link annotation It is intended that future releases of JawsMako will extend this interface. More...

#include <interactive.h>

Inheritance diagram for JawsMako::ILinkAnnotation:

[legend]

Public Member Functions
virtual CQuadPointVect	getQuadPoints () const =0
	Get the link annotation's quad points if present. The points are relative to the annotation rect. More...

virtual void	setQuadPoints (const CQuadPointVect &quadPoints)=0
	Set the link annotation's quad points. More...

virtual void	setActionOrDest (const IPDFObjectPtr &actionOrDest)=0
	Set the Action dictionary or Dest object for this annotation. More...

virtual IPDFObjectPtr	getActionOrDest () const =0
	Get the link annotation's Action or Dest object. An Action will be an IPDFDictionary object while a Dest can be IPDFArray, IPDFName, or IPDFString. More...

virtual void	setHighlightMode (const IPDFNamePtr &highlightMode)=0
	Set the Highlight mode for this annotation. More...

virtual IPDFNamePtr	getHighlightMode () const =0
	Get the link annotation's Highlight mode object. More...

virtual void	setPA (const IPDFDictionaryPtr &pa)=0
	Set the previous Action object for this annotation. More...

virtual IPDFDictionaryPtr	getPA () const =0
	Get the link annotation's previous Action object. More...

Public Member Functions inherited from JawsMako::IAnnotation
virtual eAnnotationType	getType () const =0
	Get the type of the annotation. More...

virtual const FRect &	getRect () const =0
	Get the rect in which the appearances should be displayed. More...

virtual void	setRect (const FRect &rect)=0
	Set the rect in which the appearances should be displayed. More...

virtual U8String	getContents () const =0
	Get the Contents entry in UTF-8. More...

virtual void	setContents (const U8String &contents)=0
	Set the Contents entry in UTF-8. More...

virtual IDOMColorPtr	getColor () const =0
	Get the color. The use of this color depends on the annotation type. See the PDF 1.7 specification for details. More...

virtual void	setColor (const IDOMColorPtr &color)=0
	Set the color. The use of this color depends on the annotation type. See the PDF 1.7 specification for details. More...

virtual IEDLTimePtr	getModificationTime () const =0
	Get the Modification date and time of the annotation, if present. More...

virtual void	setModificationTime (const IEDLTimePtr &modificationTime)=0
	Set the Modification date and time of the annotation. More...

virtual CAnnotationBorder	getBorder () const =0
	Get the annotation's border. See CAnnotationBorder for details. More...

virtual void	setBorder (const CAnnotationBorder &border)=0
	Set the annotation's border. More...

virtual uint32	getFlags () const =0
	Get the annotation flags. To interpret these flags please see section 8.4.2 "Annotation Flags" in the PDF 1.7 specification. More...

virtual void	setFlags (uint32 flags)=0
	Set the annotation flags. Please see section 8.4.2 "Annotation Flags" for details about these flags. More...

virtual void	rotate (uint16 rotate, double pageWidth, double pageHeight)=0
	Rotate the annotation clockwise as if the page was rotated by the same amount. More...

virtual CAnnotationAppearanceVect	getAppearances () const =0
	Return all the annotation appearances in a vector. More...

virtual void	removeAppearances ()=0
	Remove all annotation appearances.

virtual U8String	getState () const =0
	Get the current annotation state. More...

virtual void	setState (const U8String &state)=0
	Set the current annotation state. More...

virtual IAnnotationAppearancePtr	getAppearance (eAppearanceUsage usage, const U8String &state=U8String()) const =0
	Fetch the annotation appearance that should be used for the given annotation usage and state according to the following rules: More...

virtual void	addAppearance (const IAnnotationAppearancePtr &appearance)=0
	Add or replace an appearance. More...

virtual bool	hasNormalAppearance () const =0
	Does the annotation have a normal appearance? Convenience utility function. More...

virtual IAnnotationPtr	clone () const =0
	Clone the annotation. This is a deep clone. The annotation reference will remain the same. More...

virtual bool	matchesReference (const IAnnotationReferencePtr &reference) const =0
	Does this annotation match the given IAnnotationReference? More...

virtual IAnnotationReferencePtr	getReference () const =0
	Get a reference that can be used to refer to this annotation. More...

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. More...

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to. More...

Static Public Member Functions
static JAWSMAKO_API ILinkAnnotationPtr	create (const IJawsMakoPtr &jawsMako, const FRect &rect, const IDOMColorPtr &color, const IPDFObjectPtr &actionOrDest=IPDFObjectPtr(), const IPDFNamePtr &highlightMode=IPDFNamePtr(), const IPDFDictionaryPtr &pa=IPDFDictionaryPtr())
	Create a link annotation with the given parameters. More...

Additional Inherited Members
Public Types inherited from JawsMako::IAnnotation
enum	eAnnotationType { eAT3D , eATCaret , eATCircle , eATFileAttachment , eATFreeText , eATHighlight , eATInk , eATLine , eATLink , eATMovie , eATPolygon , eATPolyLine , eATPopup , eATPrinterMark , eATProjection , eATRedact , eATRichMedia , eATScreen , eATSound , eATSquare , eATSquiggly , eATStamp , eATStrikeOut , eATText , eATTrapNet , eATUnderline , eATWatermark , eATWidget , eATOther }
	Types of annotations, listed with the earliest version of PDF that supported them. More...

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

Detailed Description

A generic interface class for a link annotation It is intended that future releases of JawsMako will extend this interface.

Member Function Documentation

◆ create()

static JAWSMAKO_API ILinkAnnotationPtr JawsMako::ILinkAnnotation::create	(	const IJawsMakoPtr &	jawsMako,
		const FRect &	rect,
		const IDOMColorPtr &	color,
		const IPDFObjectPtr &	actionOrDest = `IPDFObjectPtr()`,
		const IPDFNamePtr &	highlightMode = `IPDFNamePtr()`,
		const IPDFDictionaryPtr &	pa = `IPDFDictionaryPtr()`
	)

static

Create a link annotation with the given parameters.

Parameters

jawsMako	The JawsMako instance
rect	The annotations bounds. Must not be empty.
color	Optional; The desired annotation color. If NULL, no line will be visible.
actionOrDest	Optional; The Action dictionary or Dest object to be invoked for this annotation. If NULL, no action is performed.
highlightMode	Optional; The highlight mode for the annotation when the annotation is clicked. If NULL, it uses the default which is Invert.
pa	Optional; The previous action to be attached to this annotation. This can be NULL.

Returns: ILinkAnnotationPtr A smart pointer to the new link annotation

◆ getActionOrDest()

virtual IPDFObjectPtr JawsMako::ILinkAnnotation::getActionOrDest ( ) const

pure virtual

Get the link annotation's Action or Dest object. An Action will be an IPDFDictionary object while a Dest can be IPDFArray, IPDFName, or IPDFString.

Returns: IPDFObjectPtr The link annotation's Action or Dest object

◆ getHighlightMode()

virtual IPDFNamePtr JawsMako::ILinkAnnotation::getHighlightMode ( ) const

pure virtual

Get the link annotation's Highlight mode object.

Returns: IPDFNamePtr The link annotation's highlight mode

◆ getPA()

virtual IPDFDictionaryPtr JawsMako::ILinkAnnotation::getPA ( ) const

pure virtual

Get the link annotation's previous Action object.

Returns: IPDFDictionaryPtr The link annotation's previous action dictionary object

◆ getQuadPoints()

virtual CQuadPointVect JawsMako::ILinkAnnotation::getQuadPoints ( ) const

pure virtual

Get the link annotation's quad points if present. The points are relative to the annotation rect.

Returns: CQuadPointVect The link annotation's quad points

◆ setActionOrDest()

virtual void JawsMako::ILinkAnnotation::setActionOrDest ( const IPDFObjectPtr & actionOrDest )

pure virtual

Set the Action dictionary or Dest object for this annotation.

Parameters

actionOrDest The action or dest object.

◆ setHighlightMode()

virtual void JawsMako::ILinkAnnotation::setHighlightMode ( const IPDFNamePtr & highlightMode )

pure virtual

Set the Highlight mode for this annotation.

Parameters

highlightMode The highlight mode name object. This can be N, I, O, or P.

◆ setPA()

virtual void JawsMako::ILinkAnnotation::setPA ( const IPDFDictionaryPtr & pa )

pure virtual

Set the previous Action object for this annotation.

Parameters

pa	The previous action dictionary object.

◆ setQuadPoints()

virtual void JawsMako::ILinkAnnotation::setQuadPoints ( const CQuadPointVect & quadPoints )

pure virtual

Set the link annotation's quad points.

Parameters

quadPoints The link annotation's quad points

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

interactive.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getActionOrDest()

◆ getHighlightMode()

◆ getPA()

◆ getQuadPoints()

◆ setActionOrDest()

◆ setHighlightMode()

◆ setPA()

◆ setQuadPoints()