An interface class for markup annotations. It is intended that future releases of JawsMako will extend this interface. More...

#include <interactive.h>

Inheritance diagram for JawsMako::IMarkupAnnotation:

[legend]

Public Member Functions
virtual U8String	getAuthor () const =0
	Get the Author of the markup annotation. This is the "T" entry in the annotation, which by convention is the author.

virtual void	setAuthor (const U8String &author)=0
	Set the Author of the markup annotation. This is the "T" entry in the annotation, which by convention is the author.

virtual IEDLTimePtr	getCreationTime () const =0
	Get the creation date and time of the annotation, if present.

virtual void	setCreationTime (const IEDLTimePtr &creationTime)=0
	Set the creation date and time of the annotation.

virtual float	getOpacity () const =0
	Get the opacity of the markup annotation.

virtual void	setOpacity (float opacity)=0
	Set the opacity of the markup annotation.

virtual IAnnotationReferencePtr	getPopupReference () const =0
	Get a reference to the popup, if present.

virtual void	setPopup (const IAnnotationReferencePtr &popupReference)=0
	Set or clear the popup, by reference.

virtual void	setPopup (const IPopupAnnotationPtr &popup)=0
	Set a reference to a popup, if present.

virtual IAnnotationAppearancePtr	createNormalAppearance () const =0
	Create a basic appearance given the current annotation's parameters. This can then be installed by using IAnnotation::addAppearance().

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

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

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

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

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

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.

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.

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

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

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

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

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.

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

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

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

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

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

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

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:

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

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

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

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

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

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::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

An interface class for markup annotations. It is intended that future releases of JawsMako will extend this interface.

Member Function Documentation

◆ createNormalAppearance()

virtual IAnnotationAppearancePtr JawsMako::IMarkupAnnotation::createNormalAppearance ( ) const

pure virtual

Create a basic appearance given the current annotation's parameters. This can then be installed by using IAnnotation::addAppearance().

Replaces any already present. Not yet supported for all markup annotation types. Supported for:

Shape annotations
Text annotations
Text markup annotations

Inset, Beveled, Underline and "Cloud" borders will currently result in plain borders.

Additional annotation types may be supported in future releases.

An IError with error code JM_ERR_UNSUPPORTED will be thrown for such appearances.

Returns: IAnnotationAppearancePtr A smart pointer to the resulting appearance

◆ getAuthor()

virtual U8String JawsMako::IMarkupAnnotation::getAuthor ( ) const

pure virtual

Get the Author of the markup annotation. This is the "T" entry in the annotation, which by convention is the author.

Returns: U8String The author. An empty string is returned if the entry is missing.

◆ getCreationTime()

virtual IEDLTimePtr JawsMako::IMarkupAnnotation::getCreationTime ( ) const

pure virtual

Get the creation date and time of the annotation, if present.

Returns: IEDLTimePtr The annotation's creation date and time.

If the date is not of the expected format, or is missing, a NULL object will be returned.

◆ getOpacity()

virtual float JawsMako::IMarkupAnnotation::getOpacity ( ) const

pure virtual

Get the opacity of the markup annotation.

Returns: float The opacity value

◆ getPopupReference()

virtual IAnnotationReferencePtr JawsMako::IMarkupAnnotation::getPopupReference ( ) const

pure virtual

Get a reference to the popup, if present.

Returns: IAnnotationReferencePtr The annotation reference to the popup. If there is no popup, a NULL reference will be returned.

◆ setAuthor()

virtual void JawsMako::IMarkupAnnotation::setAuthor ( const U8String & author )

pure virtual

Set the Author of the markup annotation. This is the "T" entry in the annotation, which by convention is the author.

Parameters

author The author to set. An empty string will cause the author to be removed entirely.

◆ setCreationTime()

virtual void JawsMako::IMarkupAnnotation::setCreationTime ( const IEDLTimePtr & creationTime )

pure virtual

Set the creation date and time of the annotation.

Parameters

creationTime The creation date and time. Must not be NULL.

◆ setOpacity()

virtual void JawsMako::IMarkupAnnotation::setOpacity ( float opacity )

pure virtual

Set the opacity of the markup annotation.

Parameters

opacity A value between 0.0 (fully transparent) and 1.0 (fully opaque)

◆ setPopup() [1/2]

virtual void JawsMako::IMarkupAnnotation::setPopup ( const IAnnotationReferencePtr & popupReference )

pure virtual

Set or clear the popup, by reference.

Parameters

popupReference A reference to the popup. Set to NULL to remove the current popup.

For full functionality, the popup must be added to the current page's annotations.

◆ setPopup() [2/2]

virtual void JawsMako::IMarkupAnnotation::setPopup ( const IPopupAnnotationPtr & popup )

pure virtual

Set a reference to a popup, if present.

Parameters

popup The popup. Set to NULL to remove the current popup.

For full functionality, the popup must be added to the current page's annotations.

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

interactive.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createNormalAppearance()

◆ getAuthor()

◆ getCreationTime()

◆ getOpacity()

◆ getPopupReference()

◆ setAuthor()

◆ setCreationTime()

◆ setOpacity()

◆ setPopup() [1/2]

◆ setPopup() [2/2]