|
Mako 7.3.0 API
|
|
Mako 7.3.0 API
|
A generic interface class for a text (sticky note) annotation. More...
#include <interactive.h>
Public Member Functions | |
| virtual bool | getOpen () const =0 |
| Get the annotation's open status. More... | |
| virtual void | setOpen (bool open)=0 |
| Set the annotation's open status. More... | |
| virtual U8String | getIconName () const =0 |
| Get the annotation's icon name. Must not be empty. More... | |
| virtual void | setIconName (const U8String &iconName)=0 |
| Set the annotation's icon name. More... | |
 Public Member Functions inherited from JawsMako::IMarkupAnnotation | |
| 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. More... | |
| 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. More... | |
| virtual IEDLTimePtr | getCreationTime () const =0 |
| Get the creation date and time of the annotation, if present. More... | |
| virtual void | setCreationTime (const IEDLTimePtr &creationTime)=0 |
| Set the creation date and time of the annotation. More... | |
| virtual float | getOpacity () const =0 |
| Get the opacity of the markup annotation. More... | |
| virtual void | setOpacity (float opacity)=0 |
| Set the opacity of the markup annotation. More... | |
| virtual IAnnotationReferencePtr | getPopupReference () const =0 |
| Get a reference to the popup, if present. More... | |
| virtual void | setPopup (const IAnnotationReferencePtr &popupReference)=0 |
| Set or clear the popup, by reference. More... | |
| virtual void | setPopup (const IPopupAnnotationPtr &popup)=0 |
| Set a reference to a popup, if present. More... | |
| virtual IAnnotationAppearancePtr | createNormalAppearance () const =0 |
| Create a basic appearance given the current annotation's parameters. This can then be installed by using IAnnotation::addAppearance(). 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 ITextAnnotationPtr | create (const IJawsMakoPtr &jawsMako, const FRect &rect, const U8String &contents, bool open=false, const U8String &iconName=U8String("Note"), const IPopupAnnotationPtr &popup=IPopupAnnotationPtr()) |
| Create a text annotation. 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. | |
A generic interface class for a text (sticky note) annotation.
|
static |
Create a text annotation.
| jawsMako | The JawsMako instance |
| rect | The annotations bounds. Must not be empty. |
| contents | The textual contents of the text annotation. |
| open | Optional; whether or not the note is open. Default is false. |
| iconName | Optional; the name of the icon to use for displaying the annotation. The default is "Note". Must not be empty. |
| popup | The associated popup. The associated popup must be added to the annotations of the same page. |
|
pure virtual |
Get the annotation's icon name. Must not be empty.
|
pure virtual |
Get the annotation's open status.
|
pure virtual |
Set the annotation's icon name.
| iconName | the annotation's icon name. Cannot be empty |
|
pure virtual |
Set the annotation's open status.
| open | Set to true for open, false for closed |