JawsMako::IPopupAnnotation Class Reference

An interface class for a popup annotation, which should not exist as a standalone, but is associated with a Markup Annotation. No appearances can be added to this annotation type. It is intended that future releases of JawsMako will extend this interface. More...

#include <interactive.h>

Inheritance diagram for JawsMako::IPopupAnnotation:

Public Member Functions
virtual bool	getOpen () const =0
	Get the annotation's open status.
virtual void	setOpen (bool open)=0
	Set the annotation's open status.
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.

Static Public Member Functions
static JAWSMAKO_API IPopupAnnotationPtr	create (const IJawsMakoPtr &jawsMako, const FRect &rect, bool open=false)
	Create a popup annotation.

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 a popup annotation, which should not exist as a standalone, but is associated with a Markup Annotation. No appearances can be added to this annotation type. It is intended that future releases of JawsMako will extend this interface.

Member Function Documentation

create()

static JAWSMAKO_API IPopupAnnotationPtr JawsMako::IPopupAnnotation::create ( const IJawsMakoPtr & jawsMako, const FRect & rect, bool open = false )

static

Create a popup annotation.

Parameters

jawsMako	The JawsMako instance
rect	The annotations bounds. Must not be empty.
open	Optional; whether or not the note is open. Default is false.

Returns

IPopupAnnotationPtr A smart pointer to the new popup annotation

getOpen()

virtual bool JawsMako::IPopupAnnotation::getOpen ( ) const

pure virtual

Get the annotation's open status.

Returns

bool True if open, false if closed

setOpen()

virtual void JawsMako::IPopupAnnotation::setOpen ( bool open )

pure virtual

Set the annotation's open status.

Parameters

open	Set to true for open, false for closed

---

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

• interactive.h