interactive.h

Go to the documentation of this file.

/*
 * Copyright (C) 2013-2025 Global Graphics Software Ltd. All rights reserved.
 */
 
#ifndef JAWSMAKO_INTERACTIVE_H
#define JAWSMAKO_INTERACTIVE_H

 
#include <jawsmako/types.h>
#include <jawsmako/hashable.h>
#include <edl/edlfwd.h>
#include <edl/idomform.h>
#include <edl/idomfont.h>
 
namespace JawsMako
{
    using namespace EDL;
 
    // Forward declarations
    class ILinkAnnotation;
    DECL_SMART_PTR(ILinkAnnotation);
    class IFreeTextAnnotation;
    DECL_SMART_PTR(IFreeTextAnnotation);
    class ICaretAnnotation;
    DECL_SMART_PTR(ICaretAnnotation);
    class IInkAnnotation;
    DECL_SMART_PTR(IInkAnnotation);
    class IPolyAnnotation;
    DECL_SMART_PTR(IPolyAnnotation);
    class IPopupAnnotation;
    DECL_SMART_PTR(IPopupAnnotation);
    class ILineAnnotation;
    DECL_SMART_PTR(ILineAnnotation);
    class IShapeAnnotation;
    DECL_SMART_PTR(IShapeAnnotation);
    class ISoundAnnotation;
    DECL_SMART_PTR(ISoundAnnotation);
    class IStampAnnotation;
    DECL_SMART_PTR(IStampAnnotation);
    class ITextAnnotation;
    DECL_SMART_PTR(ITextAnnotation);
    class ITextMarkupAnnotation;
    DECL_SMART_PTR(ITextMarkupAnnotation);
    class IRedactionAnnotation;
    DECL_SMART_PTR(IRedactionAnnotation);
    class IWidgetAnnotation;
    DECL_SMART_PTR(IWidgetAnnotation);
    class IAnnotationReference;
    DECL_SMART_PTR(IAnnotationReference);
    typedef CEDLVector<IAnnotationReferencePtr> CAnnotationReferenceVect;
    class IFormField;
    DECL_SMART_PTR(IFormField);
    typedef CEDLVector<IFormFieldPtr> CFormFieldVect;
    class IForm;
    DECL_SMART_PTR(IForm);
    class IAnnotationAppearance;
    DECL_SMART_PTR(IAnnotationAppearance);
    typedef CEDLVector<IAnnotationAppearancePtr> CAnnotationAppearanceVect;
    class IAnnotation;
    DECL_SMART_PTR(IAnnotation);
    class IMarkupAnnotation;
    DECL_SMART_PTR(IMarkupAnnotation);
    typedef CEDLVector<IAnnotationPtr> CAnnotationVect;
    class IWidgetAppearanceCharacteristics;
    DECL_SMART_PTR(IWidgetAppearanceCharacteristics);
    class IThreads;
    DECL_SMART_PTR(IThreads);

    class IAnnotationReference : public IRCObject
    {
      public:
        virtual ~IAnnotationReference() {}

        virtual bool equals(const IAnnotationReferencePtr &other) const = 0;
    };

    typedef enum
    {
        eFTInherited, 
        eFTButton,    
        eFTText,      
        eFTChoice,    
        eFTSignature  
    } eFieldType;

    typedef enum
    {
        eFFReadOnly = 1,
        eFFRequired = (1 << 1),
        eFFNoExport = (1 << 2),
        eFFNoToggleToOff = (1 << 14),
        eFFRadio = (1 << 15),
        eFFPushButton = (1 << 16),
        eFFRadiosInUnison = (1 << 25),
        eFFMultiline = (1 << 12),
        eFFPassword = (1 << 13),
        eFFCombo = (1 << 17),
        eFFEdit = (1 << 18),
        eFFSort = (1 << 19),
        eFFFileSelect = (1 << 20),
        eFFMultiSelect = (1 << 21),
        eFFDoNotSpellCheck = (1 << 22),
        eFFDoNotScroll = (1 << 23),
        eFFComb = (1 << 24),
        eFFRichText = (1 << 25),
        eFFCommitOnSelChanged = (1 << 26),
    } eFieldFlags;

    typedef enum
    {
        eQLeftJustified = 0,
        eQCentered = 1,
        eQRightJustified = 2,
        eQInherited,
    } eQuadding;

    class CFieldOption
    {
      public:
        CFieldOption(){}
        CFieldOption(const U8String &_label, const U8String &_exportValue = U8String())
        {
            label = _label;
            exportValue = _exportValue;
        }
        U8String label;
        U8String exportValue; // May be empty if not specified.
 
        bool operator== (const CFieldOption &other) const
        {
            return     (label == other.label)
                    && (exportValue == other.exportValue);
        }
 
        bool operator!= (const CFieldOption &other) const
        {
            return ! (*this == other);
        }
 
    };
    typedef CEDLVector<CFieldOption> CFieldOptionVect;

    class IFormField : public IRCObject
    {
      public:
        virtual ~IFormField() {}

        static JAWSMAKO_API IFormFieldPtr create(const IJawsMakoPtr &jawsMako,
                                                 eFieldType type = eFTInherited,
                                                 const U8String &partialName = U8String(),
                                                 uint32 flags = 0,
                                                 const CFormFieldVect &childFields = CFormFieldVect(),
                                                 const CAnnotationReferenceVect &childWidgets = CAnnotationReferenceVect(),
                                                 const U8String &alternateName = U8String());

        virtual IFormFieldPtr clone() const = 0;

         virtual eFieldType getFieldType() const = 0;
 
#ifdef SWIG
        %apply uint32_t &OUTPUT { uint32 &flags };
#endif
        virtual bool getFieldFlags(uint32 &flags) const = 0;
#ifdef SWIG
        %clear uint32 &flags;
#endif

        virtual void setFieldFlags(uint32 flags) = 0;

        virtual CFormFieldVect getChildFields() const = 0;

        virtual CAnnotationReferenceVect getChildWidgets() const = 0;

        virtual DOMid getFieldId() const = 0;

        virtual void clearChildFields() = 0;

        virtual void addChildField(const IFormFieldPtr &field) = 0;

        virtual void removeChildField(const IFormFieldPtr &field) = 0;

        virtual bool fieldInSubtree(const IFormFieldPtr &field) const = 0;

        virtual void clearChildWidgets() = 0;

        virtual void addChildWidget(const IWidgetAnnotationPtr &widget) = 0;

        virtual void addChildWidget(const IAnnotationReferencePtr &widgetReference) = 0;

        virtual void removeChildWidget(const IWidgetAnnotationPtr &widget) = 0;

        virtual void removeChildWidget(const IAnnotationReferencePtr &widgetReference) = 0;

        virtual bool widgetInSubtree(const IWidgetAnnotationPtr &widget) const = 0;

        virtual bool widgetInSubtree(const IAnnotationReferencePtr &widgetReference) const = 0;

            virtual U8String getPartialName() const = 0;

        virtual void setPartialName(const U8String &name) = 0;

        virtual bool getValue(CU8StringVect &value) const = 0;

        virtual void setValue(const CU8StringVect &value) = 0;

        virtual void setValue(const U8String &value)
        {
            CU8StringVect values(1);
            values[0] = value;
            setValue(values);
        }

        virtual bool getDefaultValue(CU8StringVect &value) const = 0;

        virtual void setDefaultValue(const CU8StringVect &value) = 0;

        virtual void setDefaultValue(const U8String &value)
        {
            CU8StringVect values(1);
            values[0] = value;
            setDefaultValue(values);
        }
 
        /*
         * For Fields containing variable text.
         */

        virtual bool getDefaultAppearanceString(U8String &defaultAppearanceString) const = 0;

        virtual void setDefaultAppearanceString(const U8String &defaultAppearanceString) = 0;

        virtual eQuadding getQuadding() const = 0;

        virtual void setQuadding(eQuadding quadding) = 0;
 
        /*
         * For choice and radio buttons.
         */

        virtual bool getOptions(CFieldOptionVect &options) const = 0;

        virtual void setOptions(const CFieldOptionVect &options) = 0;

        virtual U8String getAlternateName() const = 0;

        virtual void setAlternateName(const U8String &name) = 0;
    };

    class CXFAPacket
    {
      public:
        U8String        name; 
        IInputStreamPtr stream; 
 
        bool operator== (const CXFAPacket &other) const
        {
            return     (other.name      == name)
                    && (other.stream    == stream);
        }
 
        bool operator!= (const CXFAPacket &other) const
        {
            return ! (*this == other);
        }
    };
    typedef CEDLVector<CXFAPacket> CXFAPacketVect;

    class IForm : public IRCObject
    {
      public:
        virtual ~IForm() {}

        static JAWSMAKO_API IFormPtr create(const IJawsMakoPtr &jawsMako);

        virtual IFormPtr clone() const = 0;

        virtual CFormFieldVect getFields() const = 0;

        virtual CAnnotationReferenceVect getWidgets() const = 0;

        virtual void clearFields() = 0;

        virtual void addField(const IFormFieldPtr &field) = 0;

        virtual void removeField(const IFormFieldPtr &field) = 0;

        virtual void clearWidgets() = 0;

        virtual void addWidget(const IWidgetAnnotationPtr &widget) = 0;

        virtual void addWidget(const IAnnotationReferencePtr &widgetReference) = 0;

        virtual void removeWidget(const IWidgetAnnotationPtr &widget) = 0;

        virtual void removeWidget(const IAnnotationReferencePtr &widgetReference) = 0;

        virtual bool fieldInTree(const IFormFieldPtr &field) const = 0;

        virtual CFormFieldVect getPathToField(const IFormFieldPtr &field) const = 0;

        virtual bool widgetInTree(const IWidgetAnnotationPtr &widget) const = 0;

        virtual bool widgetInTree(const IAnnotationReferencePtr &widgetReference) const = 0;

        virtual CFormFieldVect getPathToWidget(const IWidgetAnnotationPtr &widget) const = 0;

        virtual CFormFieldVect getPathToWidget(const IAnnotationReferencePtr &widgetReference) const = 0;

        virtual eFieldType getWidgetFieldType(const IWidgetAnnotationPtr &widget) const = 0;

        virtual uint32 getWidgetFieldFlags(const IWidgetAnnotationPtr &widget) const = 0;

        virtual U8String getWidgetDefaultAppearanceString(const IWidgetAnnotationPtr &widget) const = 0;

        virtual CU8StringVect getWidgetValue(const IWidgetAnnotationPtr &widget) const = 0;

        virtual CU8StringVect getWidgetDefaultValue(const IWidgetAnnotationPtr &widget) const = 0;

        virtual CU8StringVect getFieldValue(const IFormFieldPtr &field) const = 0;

        virtual CU8StringVect getFieldDefaultValue(const IFormFieldPtr &field) const = 0;

        virtual CFieldOptionVect getWidgetOptions(const IWidgetAnnotationPtr &widget) const = 0;

        virtual eQuadding getWidgetQuadding(const IWidgetAnnotationPtr &widget) const = 0;

        virtual bool getNeedAppearances() const = 0;

        virtual void setNeedAppearances(bool needAppearances) = 0;

        virtual CXFAPacketVect getXfaPacketData() const = 0;

        virtual void setXfaPacketData(const CXFAPacketVect &xfaPacketData) = 0;
    };

    typedef enum
    {
        eAUNormal,    
        eAURollover,  
        eAUDown,      
    } eAppearanceUsage;

    class IAnnotationAppearance : public IRCObject
    {
      public:
        virtual ~IAnnotationAppearance() {}

        static JAWSMAKO_API IAnnotationAppearancePtr create(const IJawsMakoPtr &jawsMako, const IDOMFormPtr &form, eAppearanceUsage usage, const U8String &state = U8String());

        virtual IAnnotationAppearancePtr clone() const = 0;

        virtual eAppearanceUsage getUsage() const = 0;

        virtual U8String getState() const = 0;

        virtual IDOMFormPtr getForm() const = 0;

        virtual IDOMNodePtr getScaledAppearance(const FRect &annotRect) const = 0;
    };

    class CAnnotationBorder
    {
      public:
        typedef enum
        {
            eBTSolid,     
            eBTDashed,    
            eBTBeveled,   
            eBTInset,     
            eBTUnderline  
        } eBorderType;

        CAnnotationBorder(float inWidth = 1.0f / 72.0f * 96.0f, const eBorderType &inType = eBTSolid, const CEDLVector<float> &inDash = CEDLVector<float>())
        {
            width = inWidth;
            type = inType;
            dash = inDash;
        }
 
        float width;             
        eBorderType type;        
        CEDLVector<float> dash;  
    };

    class IAnnotation : public IRCObject
    {
      public:
        virtual ~IAnnotation() {}

        typedef enum
        {
            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,          
        } eAnnotationType;

        virtual eAnnotationType getType() const = 0;

        virtual const FRect &getRect() const = 0;

        virtual void setRect(const FRect &rect) = 0;

        virtual U8String getContents() const = 0;

        virtual void setContents(const U8String &contents) = 0;

        virtual IDOMColorPtr getColor() const = 0;

        virtual void setColor(const IDOMColorPtr &color) = 0;

        virtual IEDLTimePtr getModificationTime() const = 0;

        virtual void setModificationTime(const IEDLTimePtr &modificationTime) = 0;

        virtual CAnnotationBorder getBorder() const = 0;

        virtual void setBorder(const CAnnotationBorder &border) = 0;

        virtual uint32 getFlags() const = 0;

        virtual void setFlags(uint32 flags) = 0;

        virtual void rotate(uint16 rotate, double pageWidth, double pageHeight) = 0;

        virtual CAnnotationAppearanceVect getAppearances() const = 0;

        virtual void removeAppearances() = 0;

        virtual U8String getState() const = 0;

        virtual void setState(const U8String &state) = 0;

        virtual IAnnotationAppearancePtr getAppearance(eAppearanceUsage usage, const U8String &state = U8String()) const = 0;

        virtual void addAppearance(const IAnnotationAppearancePtr &appearance) = 0;

        virtual bool hasNormalAppearance() const = 0;
 

        virtual IAnnotationPtr clone() const = 0;

        virtual bool matchesReference(const IAnnotationReferencePtr &reference) const = 0;

        virtual IAnnotationReferencePtr getReference() const = 0;
 
    };

    class IMarkupAnnotation : public IAnnotation
    {
      public:
        virtual ~IMarkupAnnotation() {}

        virtual U8String getAuthor() const = 0;

        virtual void setAuthor(const U8String &author) = 0;

        virtual IEDLTimePtr getCreationTime() const = 0;

        virtual void setCreationTime(const IEDLTimePtr &creationTime) = 0;

        virtual float getOpacity() const = 0;

        virtual void setOpacity(float opacity) = 0;

        virtual IAnnotationReferencePtr getPopupReference() const = 0;

        virtual void setPopup(const IAnnotationReferencePtr &popupReference) = 0;

        virtual void setPopup(const IPopupAnnotationPtr &popup) = 0;

        virtual IAnnotationAppearancePtr createNormalAppearance() const = 0;
 
    };
    #define obj2IMarkupAnnotation(obj) IMarkupAnnotationPtr(dynamic_cast<IMarkupAnnotation *>((IRCObject *) obj), true)

    class CQuadPoint
    {
      public:
        CQuadPoint() {}
        CQuadPoint(const FPoint &inP1, const FPoint &inP2, const FPoint &inP3, const FPoint &inP4)
        {
            p1 = inP1;
            p2 = inP2;
            p3 = inP3;
            p4 = inP4;
        }
        FPoint p1;
        FPoint p2;
        FPoint p3;
        FPoint p4;
 
        bool operator== (const CQuadPoint &other) const
        {
            return     (other.p1 == p1)
                    && (other.p2 == p2)
                    && (other.p3 == p3)
                    && (other.p4 == p4);
        }
 
        bool operator!= (const CQuadPoint &other) const
        {
            return ! (*this == other);
        }
    };
    typedef CEDLVector<CQuadPoint> CQuadPointVect;
 
    typedef CEDLVector<CFPointVect> CFPointVectVect;
 

    class CRectInset
    {
      public:
        CRectInset(double _left = 0.0, double _top = 0.0, double _right = 0.0, double _bottom = 0.0)
        {
            left = _left;
            top = _top;
            right = _right;
            bottom = _bottom;
        }
        double left;
        double top;
        double right;
        double bottom;
    };

    class IWidgetAppearanceCharacteristics : public IRCObject
    {
      public:
        static JAWSMAKO_API IWidgetAppearanceCharacteristicsPtr create(const IJawsMakoPtr &jawsMako,
                                                                       int32 rotation = 0,
                                                                       const IDOMColorPtr &borderColor = IDOMColorPtr(),
                                                                       const IDOMColorPtr &backgroundColor = IDOMColorPtr(),
                                                                       const U8String &caption = U8String(),
                                                                       const U8String &rolloverCaption = U8String(),
                                                                       const U8String &alternateCaption = U8String());

        virtual int32 getRotation() const = 0;

        virtual void setRotation(int32 rotation) = 0;

        virtual IDOMColorPtr getBorderColor() const = 0;

        virtual void setBorderColor(const IDOMColorPtr &color) = 0;

        virtual IDOMColorPtr getBackgroundColor() const = 0;

        virtual void setBackgroundColor(const IDOMColorPtr &color) = 0;

        virtual U8String getCaption() const = 0;

        virtual void setCaption(const U8String &caption) = 0;

        virtual U8String getRolloverCaption() const = 0;

        virtual void setRolloverCaption(const U8String &caption) = 0;

        virtual U8String getAlternateCaption() const = 0;

        virtual void setAlternateCaption(const U8String &caption) = 0;
    };

    class IWidgetAnnotation : public IAnnotation
    {
      public:
        virtual ~IWidgetAnnotation() {}

        typedef enum
        {
            eHMNone = 0,
            eHMInvert,
            eHMOutline,
            eHMPush,
            eHMToggle
        } eHighlightMode;

        typedef enum
        {
            eFELatin = 0,
            eFEJapanese,
            eFESimplifiedChinese,
            eFETraditionalChinese,
            eFEKorean
        } eFontEncoding;

        virtual void createBasicAppearances(const IFormPtr &form,
                                            const U8String &onStateName = U8String(),
                                            const IDOMFontPtr &font = IDOMFontPtr(),
                                            uint32 fontIndex = 0,
                                            float captionSize = 10.0f) = 0;

        static JAWSMAKO_API IWidgetAnnotationPtr createTextField(const IJawsMakoPtr &jawsMako,
                                                                 const IFormPtr &form,
                                                                 const IPagePtr &page,
                                                                 const FRect &rect,
                                                                 const U8String &partialName,
                                                                 const U8String &text,
                                                                 float textSize,
                                                                 const IDOMFontOpenTypePtr &font,
                                                                 uint32 fontIndex = 0,
                                                                 eFontEncoding encodingHint = eFELatin,
                                                                 const IDOMColorPtr &color = IDOMColorPtr(),
                                                                 bool multiLine = false,
                                                                 eQuadding quadding = eQLeftJustified,
                                                                 const U8String &alternateName = U8String());

        static JAWSMAKO_API IWidgetAnnotationPtr createCheckButton(const IJawsMakoPtr &jawsMako,
                                                                   const IFormPtr &form,
                                                                   const IPagePtr &page,
                                                                   const FRect &rect,
                                                                   const U8String &partialName,
                                                                   const U8String &onValue,
                                                                   bool on = false,
                                                                   const U8String &alternateName = U8String());
 
        class CRadioButtonInfo
        {
          public:
            CRadioButtonInfo() {}
            CRadioButtonInfo(const FRect &_rect, const U8String &_onValue) :
                            rect(_rect), onValue(_onValue) {}
 
            FRect rect;
            U8String onValue;
 
            bool operator== (const CRadioButtonInfo &other) const
            {
                return     (other.rect    == rect)
                        && (other.onValue == onValue);
            }
 
            bool operator!= (const CRadioButtonInfo &other) const
            {
                return ! (*this == other);
            }
        };
        typedef CEDLVector<CRadioButtonInfo> CRadioButtonInfoVect;

        static JAWSMAKO_API IFormFieldPtr createRadioButtons(const IJawsMakoPtr &jawsMako,
                                                             const IFormPtr &form,
                                                             const IPagePtr &page,
                                                             const U8String &partialName,
                                                             const U8String &value,
                                                             const CRadioButtonInfoVect &buttonDetails,
                                                             const U8String &alternateName = U8String());

        static JAWSMAKO_API IWidgetAnnotationPtr createChoiceField(const IJawsMakoPtr &jawsMako,
                                                                   const IFormPtr &form,
                                                                   const IPagePtr &page,
                                                                   const FRect &rect,
                                                                   const U8String &partialName,
                                                                   bool combo,
                                                                   bool editable,
                                                                   bool multiSelect,
                                                                   const CFieldOptionVect &options,
                                                                   const CU8StringVect &selectedOptions,
                                                                   float textSize,
                                                                   const IDOMFontOpenTypePtr &font,
                                                                   uint32 fontIndex = 0,
                                                                   eFontEncoding encodingHint = eFELatin,
                                                                   const IDOMColorPtr &color = IDOMColorPtr(),
                                                                   const U8String &alternateName = U8String());

        static JAWSMAKO_API IWidgetAnnotationPtr createButton(const IJawsMakoPtr &jawsMako,
                                                              const IFormPtr &form,
                                                              const IPagePtr &page,
                                                              const FRect &rect,
                                                              const U8String &partialName,
                                                              const U8String &caption,
                                                              float textSize,
                                                              const IDOMFontOpenTypePtr &font,
                                                              uint32 fontIndex = 0,
                                                              eFontEncoding encodingHint = eFELatin,
                                                              const IDOMColorPtr &color = IDOMColorPtr(),
                                                              const IDOMColorPtr &backgroundColor = IDOMColorPtr(),
                                                              const IPDFDictionaryPtr &actions = IPDFDictionaryPtr(),
                                                              const U8String &alternateName = U8String());

        virtual eFieldType getFieldType() const = 0;

        virtual U8String getPartialName() const = 0;

        virtual void setPartialName(const U8String &name) = 0;

        virtual eHighlightMode getHighlightMode() const = 0;

        virtual void setHighlightMode(eHighlightMode highlightMode) = 0;
 
#ifdef SWIG
        %apply uint32_t &OUTPUT { uint32 &flags };
#endif
        virtual bool getFieldFlags(uint32 &flags) const = 0;
#ifdef SWIG
        %clear uint32 &flags;
#endif

        virtual void setFieldFlags(uint32 flags) = 0;
 

        virtual IWidgetAppearanceCharacteristicsPtr getAppearanceCharacteristics() const = 0;

        virtual void setAppearanceCharacteristics(const IWidgetAppearanceCharacteristicsPtr &appearanceCharacteristics) = 0;

        virtual bool getValue(CU8StringVect &value) const = 0;

        virtual void setValue(const CU8StringVect &value) = 0;

        virtual void setValue(const U8String &value)
        {
            CU8StringVect values(1);
            values[0] = value;
            setValue(values);
        }

        virtual bool getDefaultValue(CU8StringVect &value) const = 0;

        virtual void setDefaultValue(const CU8StringVect &value) = 0;

        virtual void setDefaultValue(const U8String &value)
        {
            CU8StringVect values(1);
            values[0] = value;
            setDefaultValue(values);
        }
 
 
        /*
         * For Fields containing text, such as buttons, choices, and text fields.
         */

        virtual bool getDefaultAppearanceString(U8String &defaultAppearanceString) const = 0;

        virtual void setDefaultAppearanceString(const U8String &defaultAppearanceString) = 0;
 
        /*
         * For text fields.
         */

        virtual eQuadding getQuadding() const = 0;

        virtual void setQuadding(eQuadding quadding) = 0;
 
        /*
         * For choice and radio button fields.
         */

        virtual bool getOptions(CFieldOptionVect &options) const = 0;

        virtual void setOptions(const CFieldOptionVect &options) = 0;

        virtual uint32 getFirstVisibleOption() const = 0;

        virtual void setFirstVisibleOption(uint32 option) = 0;

        virtual CUInt32Vect getSelectedOptions() const = 0;

        virtual void setSelectedOptions(const CUInt32Vect &selectedOptions) = 0;

        virtual IPDFDictionaryConstPtr getActionsDictionary() const = 0;

        virtual void setActionsDictionary(const IPDFDictionaryPtr &actions) = 0;

        virtual IPDFDictionaryConstPtr getAdditionalActionsDictionary() const = 0;

        virtual void setAdditionalActionsDictionary(const IPDFDictionaryPtr &actions) = 0;

        virtual U8String getAlternateName() const = 0;

        virtual void setAlternateName(const U8String &name) = 0;
 
    };
    #define obj2IWidgetAnnotation(obj) IWidgetAnnotationPtr(dynamic_cast<IWidgetAnnotation *>((IRCObject *) obj), true)

    class ITextMarkupAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~ITextMarkupAnnotation() {}

        virtual CQuadPointVect getQuadPoints() const = 0;

        virtual void setQuadPoints(const CQuadPointVect &quadPoints) = 0;
    };
    #define obj2ITextMarkupAnnotation(obj) ITextMarkupAnnotationPtr(dynamic_cast<ITextMarkupAnnotation *>((IRCObject *) obj), true)

    class ILinkAnnotation : public IAnnotation
    {
      public:
        virtual ~ILinkAnnotation() {}

        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 ()
                                        );

        virtual CQuadPointVect getQuadPoints() const = 0;

        virtual void setQuadPoints(const CQuadPointVect &quadPoints) = 0;

        virtual void setActionOrDest (const IPDFObjectPtr &actionOrDest) = 0;

        virtual IPDFObjectPtr getActionOrDest () const = 0;

        virtual void setHighlightMode (const IPDFNamePtr &highlightMode) = 0;

        virtual IPDFNamePtr getHighlightMode () const = 0;

        virtual void setPA (const IPDFDictionaryPtr &pa) = 0;

        virtual IPDFDictionaryPtr getPA () const = 0;
 
    };
    #define obj2ILinkAnnotation(obj) ILinkAnnotationPtr(dynamic_cast<ILinkAnnotation *>((IRCObject *) obj), true)

    class IFreeTextAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~IFreeTextAnnotation() {}

        virtual CRectInset getRectInset() const = 0;

        virtual CFPointVect getCalloutLine() const = 0;
    };
    #define obj2IFreeTextAnnotation(obj) IFreeTextAnnotationPtr(dynamic_cast<IFreeTextAnnotation *>((IRCObject *) obj), true)

    class ICaretAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~ICaretAnnotation() {}

        virtual CRectInset getRectInset() const = 0;
    };
    #define obj2ICaretAnnotation(obj) ICaretAnnotationPtr(dynamic_cast<ICaretAnnotation *>((IRCObject *) obj), true)

    class IShapeAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~IShapeAnnotation() {}

        static JAWSMAKO_API IShapeAnnotationPtr create(const IJawsMakoPtr &jawsMako, const FRect &rect,
                                                       IAnnotation::eAnnotationType type,
                                                       const IDOMColorPtr &color = IDOMColorPtr(),
                                                       const CAnnotationBorder &border = CAnnotationBorder(),
                                                       const IDOMColorPtr &interior = IDOMColorPtr(),
                                                       const CRectInset &inset = CRectInset());

        virtual CRectInset getRectInset() const = 0;

        virtual IDOMColorPtr getInteriorColor() const = 0;

        virtual void setInteriorColor(const IDOMColorPtr &color) = 0;
    };
    #define obj2IShapeAnnotation(obj) IShapeAnnotationPtr(dynamic_cast<IShapeAnnotation *>((IRCObject *) obj), true)

    class IPolyAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~IPolyAnnotation() {}

        virtual CFPointVect getPoints() const = 0;

        virtual void setPoints(const CFPointVect &points) = 0;
    };
    #define obj2IPolyAnnotation(obj) IPolyAnnotationPtr(dynamic_cast<IPolyAnnotation *>((IRCObject *) obj), true)

    class ILineAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~ILineAnnotation() {}

        virtual void getLineEndpoints(FPoint &start, FPoint &end) const = 0;

        virtual void setLineEndpoints(const FPoint &start, const FPoint &end) = 0;

        virtual float getLeaderLineLength() const = 0;

        virtual float getLeaderLineExtensionsLength() const = 0;

        virtual float getLeaderLineOffset() const = 0;
 
#ifdef SWIG
        %apply float &OUTPUT { float &xOffset };
        %apply float &OUTPUT { float &yOffset };
#endif
        virtual void getCaptionOffset(float &xOffset, float &yOffset) const = 0;
#ifdef SWIG
        %clear float &xOffset;
        %clear float &yOffset;
#endif

        virtual IDOMColorPtr getInteriorColor() const = 0;

        virtual void setInteriorColor(const IDOMColorPtr &color) = 0;
 
    };
    #define obj2ILineAnnotation(obj) ILineAnnotationPtr(dynamic_cast<ILineAnnotation *>((IRCObject *) obj), true)

    class IInkAnnotation : public IMarkupAnnotation
    {
    public:
        virtual ~IInkAnnotation() {}

         static JAWSMAKO_API IInkAnnotationPtr create(const IJawsMakoPtr &jawsMako, const FRect &rect,
                                                     const IDOMColorPtr &color = IDOMColorPtr(),
                                                     const CFPointVectVect &inkList = CFPointVectVect());

        virtual CFPointVectVect getInkList() const = 0;

        virtual void setInkList(const CFPointVectVect &inkList) = 0;
    };
    #define obj2IInkAnnotation(obj) IInkAnnotationPtr(dynamic_cast<IInkAnnotation *>((IRCObject *) obj), true)

    class IPopupAnnotation : public IAnnotation
    {
      public:
        virtual ~IPopupAnnotation() {}

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

        virtual bool getOpen() const = 0;

        virtual void setOpen(bool open) = 0;
    };
    #define obj2IPopupAnnotation(obj) IPopupAnnotationPtr(dynamic_cast<IPopupAnnotation *>((IRCObject *) obj), true)

    class ISoundAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~ISoundAnnotation() {}

        virtual IInputStreamPtr getSoundAsWav() const = 0;
    };
    #define obj2ISoundAnnotation(obj) ISoundAnnotationPtr(dynamic_cast<ISoundAnnotation *>((IRCObject *) obj), true)

    class ITextAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~ITextAnnotation() {}

        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());

        virtual bool getOpen() const = 0;

        virtual void setOpen(bool open) = 0;

        virtual U8String getIconName() const = 0;

        virtual void setIconName(const U8String &iconName) = 0;
 
    };
    #define obj2ITextAnnotation(obj) ITextAnnotationPtr(dynamic_cast<ITextAnnotation *>((IRCObject *) obj), true)

    class IRedactionAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~IRedactionAnnotation() {}

        static JAWSMAKO_API IRedactionAnnotationPtr create(const IJawsMakoPtr &jawsMako, const FRect &rect,
                                                           const CQuadPointVect &quadPoints = CQuadPointVect(),
                                                           const IDOMColorPtr &color = IDOMColorPtr(),
                                                           const IDOMColorPtr &interiorColor = IDOMColorPtr());
        virtual CQuadPointVect getQuadPoints() const = 0;

        virtual void setQuadPoints(const CQuadPointVect &quadPoints) = 0;

        virtual IDOMColorPtr getInteriorColor() const = 0;

        virtual void setInteriorColor(const IDOMColorPtr &color) = 0;
    };
    #define obj2IRedactionAnnotation(obj) IRedactionAnnotationPtr(dynamic_cast<IRedactionAnnotation *>((IRCObject *) obj), true)

    class IStampAnnotation : public IMarkupAnnotation
    {
      public:
        virtual ~IStampAnnotation() {}

        static JAWSMAKO_API IStampAnnotationPtr create(const IJawsMakoPtr &jawsMako, const FRect &rect,
                                                       const U8String &name = U8String("Draft"));
        virtual U8String getName() const = 0;

        virtual void setName(const U8String &name) = 0;

        virtual U8String getIntent() const = 0;

        virtual void setIntent(const U8String &intent) = 0;
 
    };
#define obj2IStampAnnotation(obj) IStampAnnotationPtr(dynamic_cast<IStampAnnotation *>((IRCObject *) obj), true)

    class IThreads : public IRCObject
    {
      public:
        virtual ~IThreads() {}
 
        virtual IThreadsPtr clone() const = 0;
    };

    class IAnnotationUtils
    {
      public:

        class CXMLResource
        {
          public:
            U8String       name;
            U8String       mimeType;
            IInputStreamPtr resource;
 
            bool operator== (const CXMLResource &other) const
            {
                return     (other.name      == name)
                        && (other.mimeType  == mimeType)
                        && (other.resource  == resource);
            }
 
            bool operator!= (const CXMLResource &other) const
            {
                return ! (*this == other);
            }
        };
        typedef CEDLVector<CXMLResource> CXMLResourceVect;

        static JAWSMAKO_API IRAInputStreamPtr generateXMLForDocument(const IJawsMakoPtr &jawsMako, const IDocumentPtr &document, CXMLResourceVect &resources);

        static JAWSMAKO_API IAnnotationReferencePtr createAnnotationReferenceFromTag(const U8String &tag);
    };

    class INamedDestination : public IRCObject
    {
      public:
        virtual ~INamedDestination() {}

        static JAWSMAKO_API INamedDestinationPtr create(const IJawsMakoPtr &jawsMako, const U8String &name, const IDOMPageRectTargetPtr &target);

        virtual INamedDestinationPtr clone() const = 0;

        virtual const U8String &getName() const = 0;

        virtual IDOMPageRectTargetPtr getTarget() const = 0;
    };
 
}
 
#endif