JawsMako interactive features. More...

#include <jawsmako/types.h>
#include <jawsmako/hashable.h>
#include <edl/edlfwd.h>
#include <edl/idomform.h>
#include <edl/idomfont.h>

Include dependency graph for interactive.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	JawsMako::IAnnotationReference
	A generic reference to an annotation. The target annotation might not be loaded. Chiefly used to refer to annotations from a Form. More...
class	JawsMako::CFieldOption
	Class to store form field option array entries. More...
class	JawsMako::IFormField
	An interface class for a form field. A form field may have multiple child fields and widget annotations, arranged in a tree. More...
class	JawsMako::CXFAPacket
	A class encapsulating an entry in an XFA array. More...
class	JawsMako::IForm
	An interface class for an interactive form, which tracks a tree of IFormFields and widgets. More...
class	JawsMako::IAnnotationAppearance
	An interface class for an annotation appearance, describing the graphical. content of an annotation in a given usage and state. Annotation appearances are immutable. More...
class	JawsMako::CAnnotationBorder
	A class representing an annotation's border (described in the PDF Specification as BorderStyle). The meaning of a border style depends on the annotation type and not all annotation types will support all attributes of this class, and neither will all PDF versions support all attributes. Please refer to the PDF 1.7 specification for the required styles. JawsMako will only store the attributes that are valid for the given type, but will not signal errors for this case. More...
class	JawsMako::IAnnotation
	An interface class for an annotation. More...
class	JawsMako::IMarkupAnnotation
	An interface class for markup annotations. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::CQuadPoint
	A representation of a PDF Quadpoint, in DOM coordinates. More...
class	JawsMako::CRectInset
	A class which specifies an inset from a rectangle. More...
class	JawsMako::IWidgetAppearanceCharacteristics
	Appearance information for a widget annotation. More...
class	JawsMako::IWidgetAnnotation
	An interface class for a widget annotation. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::IWidgetAnnotation::CRadioButtonInfo
class	JawsMako::ITextMarkupAnnotation
	A generic interface class for a text markup annotation. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::ILinkAnnotation
	A generic interface class for a link annotation. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::IFreeTextAnnotation
	A generic interface class for a free text annotation. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::ICaretAnnotation
	A generic interface class for a caret annotation. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::IShapeAnnotation
	A generic interface class for circle and square annotations. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::IPolyAnnotation
	An interface class for a polygon or polyline annotation. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::ILineAnnotation
	An interface class for a line annotation. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::IInkAnnotation
	A generic interface class for a ink annotation. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::IPopupAnnotation
	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...
class	JawsMako::ISoundAnnotation
	An interface class for a sound annotation. Allows access to the sound as a WAV stream if the stream is embedded. It is intended that future releases of JawsMako will extend this interface. More...
class	JawsMako::ITextAnnotation
	A generic interface class for a text (sticky note) annotation. More...
class	JawsMako::IRedactionAnnotation
	A generic interface class for a redaction annotation. More...
class	JawsMako::IStampAnnotation
	A generic interface class for a stamp annotation. More...
class	JawsMako::IThreads
	An interface class for document threads, Currently a stub interface. More...
class	JawsMako::IAnnotationUtils
class	JawsMako::IAnnotationUtils::CXMLResource
	Simple class for tracking streams associated with XML generated by generateXMLForDocument(). More...
class	JawsMako::INamedDestination
	A named destination in a PDF Document. More...

Namespaces
namespace	JawsMako

Macros
#define	obj2IMarkupAnnotation(obj)
#define	obj2IWidgetAnnotation(obj)
#define	obj2ITextMarkupAnnotation(obj)
#define	obj2ILinkAnnotation(obj)
#define	obj2IFreeTextAnnotation(obj)
#define	obj2ICaretAnnotation(obj)
#define	obj2IShapeAnnotation(obj)
#define	obj2IPolyAnnotation(obj)
#define	obj2ILineAnnotation(obj)
#define	obj2IInkAnnotation(obj)
#define	obj2IPopupAnnotation(obj)
#define	obj2ISoundAnnotation(obj)
#define	obj2ITextAnnotation(obj)
#define	obj2IRedactionAnnotation(obj)
#define	obj2IStampAnnotation(obj)

Typedefs
typedef CEDLVector< IAnnotationReferencePtr >	JawsMako::CAnnotationReferenceVect
typedef CEDLVector< IFormFieldPtr >	JawsMako::CFormFieldVect
typedef CEDLVector< IAnnotationAppearancePtr >	JawsMako::CAnnotationAppearanceVect
typedef CEDLVector< IAnnotationPtr >	JawsMako::CAnnotationVect
typedef CEDLVector< CFieldOption >	JawsMako::CFieldOptionVect
typedef CEDLVector< CXFAPacket >	JawsMako::CXFAPacketVect
typedef CEDLVector< CQuadPoint >	JawsMako::CQuadPointVect
typedef CEDLVector< CFPointVect >	JawsMako::CFPointVectVect

Enumerations
enum	JawsMako::eFieldType { JawsMako::eFTInherited , JawsMako::eFTButton , JawsMako::eFTText , JawsMako::eFTChoice , JawsMako::eFTSignature }
	The type of a form field. These map to field types present in the pdf specification. More...
enum	JawsMako::eFieldFlags { JawsMako::eFFReadOnly = 1 , JawsMako::eFFRequired = (1 << 1) , JawsMako::eFFNoExport = (1 << 2) , JawsMako::eFFNoToggleToOff = (1 << 14) , JawsMako::eFFRadio = (1 << 15) , JawsMako::eFFPushButton = (1 << 16) , JawsMako::eFFRadiosInUnison = (1 << 25) , JawsMako::eFFMultiline = (1 << 12) , JawsMako::eFFPassword = (1 << 13) , JawsMako::eFFCombo = (1 << 17) , JawsMako::eFFEdit = (1 << 18) , JawsMako::eFFSort = (1 << 19) , JawsMako::eFFFileSelect = (1 << 20) , JawsMako::eFFMultiSelect = (1 << 21) , JawsMako::eFFDoNotSpellCheck = (1 << 22) , JawsMako::eFFDoNotScroll = (1 << 23) , JawsMako::eFFComb = (1 << 24) , JawsMako::eFFRichText = (1 << 25) , JawsMako::eFFCommitOnSelChanged = (1 << 26) }
	Flags used in form fields. More...
enum	JawsMako::eQuadding { JawsMako::eQLeftJustified = 0 , JawsMako::eQCentered = 1 , JawsMako::eQRightJustified = 2 , JawsMako::eQInherited }
	The type of quadding (justification) used for variable text in a form field. More...
enum	JawsMako::eAppearanceUsage { JawsMako::eAUNormal , JawsMako::eAURollover , JawsMako::eAUDown }
	The usage scenario for an annotation appearance. More...

Functions
	JawsMako::DECL_SMART_PTR (ILinkAnnotation)
	JawsMako::DECL_SMART_PTR (IFreeTextAnnotation)
	JawsMako::DECL_SMART_PTR (ICaretAnnotation)
	JawsMako::DECL_SMART_PTR (IInkAnnotation)
	JawsMako::DECL_SMART_PTR (IPolyAnnotation)
	JawsMako::DECL_SMART_PTR (IPopupAnnotation)
	JawsMako::DECL_SMART_PTR (ILineAnnotation)
	JawsMako::DECL_SMART_PTR (IShapeAnnotation)
	JawsMako::DECL_SMART_PTR (ISoundAnnotation)
	JawsMako::DECL_SMART_PTR (IStampAnnotation)
	JawsMako::DECL_SMART_PTR (ITextAnnotation)
	JawsMako::DECL_SMART_PTR (ITextMarkupAnnotation)
	JawsMako::DECL_SMART_PTR (IRedactionAnnotation)
	JawsMako::DECL_SMART_PTR (IWidgetAnnotation)
	JawsMako::DECL_SMART_PTR (IAnnotationReference)
	JawsMako::DECL_SMART_PTR (IFormField)
	JawsMako::DECL_SMART_PTR (IForm)
	JawsMako::DECL_SMART_PTR (IAnnotationAppearance)
	JawsMako::DECL_SMART_PTR (IAnnotation)
	JawsMako::DECL_SMART_PTR (IMarkupAnnotation)
	JawsMako::DECL_SMART_PTR (IWidgetAppearanceCharacteristics)
	JawsMako::DECL_SMART_PTR (IThreads)

Detailed Description

JawsMako interactive features.

This header contains definitions of interactive objects of JawsMako, such as annotations and forms.

Macro Definition Documentation

◆ obj2ICaretAnnotation

#define obj2ICaretAnnotation ( obj )

Value:

ICaretAnnotationPtr(dynamic_cast<ICaretAnnotation *>((IRCObject *) obj), true)

IRCObject

Base class Interface for all Reference Counted objects.

Definition ircobject.h:35

◆ obj2IFreeTextAnnotation

#define obj2IFreeTextAnnotation ( obj )

Value:

IFreeTextAnnotationPtr(dynamic_cast<IFreeTextAnnotation *>((IRCObject *) obj), true)

◆ obj2IInkAnnotation

#define obj2IInkAnnotation ( obj )

Value:

IInkAnnotationPtr(dynamic_cast<IInkAnnotation *>((IRCObject *) obj), true)

◆ obj2ILineAnnotation

#define obj2ILineAnnotation ( obj )

Value:

ILineAnnotationPtr(dynamic_cast<ILineAnnotation *>((IRCObject *) obj), true)

◆ obj2ILinkAnnotation

#define obj2ILinkAnnotation ( obj )

Value:

ILinkAnnotationPtr(dynamic_cast<ILinkAnnotation *>((IRCObject *) obj), true)

◆ obj2IMarkupAnnotation

#define obj2IMarkupAnnotation ( obj )

Value:

IMarkupAnnotationPtr(dynamic_cast<IMarkupAnnotation *>((IRCObject *) obj), true)

◆ obj2IPolyAnnotation

#define obj2IPolyAnnotation ( obj )

Value:

IPolyAnnotationPtr(dynamic_cast<IPolyAnnotation *>((IRCObject *) obj), true)

◆ obj2IPopupAnnotation

#define obj2IPopupAnnotation ( obj )

Value:

IPopupAnnotationPtr(dynamic_cast<IPopupAnnotation *>((IRCObject *) obj), true)

◆ obj2IRedactionAnnotation

#define obj2IRedactionAnnotation ( obj )

Value:

IRedactionAnnotationPtr(dynamic_cast<IRedactionAnnotation *>((IRCObject *) obj), true)

◆ obj2IShapeAnnotation

#define obj2IShapeAnnotation ( obj )

Value:

IShapeAnnotationPtr(dynamic_cast<IShapeAnnotation *>((IRCObject *) obj), true)

◆ obj2ISoundAnnotation

#define obj2ISoundAnnotation ( obj )

Value:

ISoundAnnotationPtr(dynamic_cast<ISoundAnnotation *>((IRCObject *) obj), true)

◆ obj2IStampAnnotation

#define obj2IStampAnnotation ( obj )

Value:

IStampAnnotationPtr(dynamic_cast<IStampAnnotation *>((IRCObject *) obj), true)

◆ obj2ITextAnnotation

#define obj2ITextAnnotation ( obj )

Value:

ITextAnnotationPtr(dynamic_cast<ITextAnnotation *>((IRCObject *) obj), true)

◆ obj2ITextMarkupAnnotation

#define obj2ITextMarkupAnnotation ( obj )

Value:

ITextMarkupAnnotationPtr(dynamic_cast<ITextMarkupAnnotation *>((IRCObject *) obj), true)

◆ obj2IWidgetAnnotation

#define obj2IWidgetAnnotation ( obj )

Value:

IWidgetAnnotationPtr(dynamic_cast<IWidgetAnnotation *>((IRCObject *) obj), true)

Classes

Namespaces

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ obj2ICaretAnnotation

◆ obj2IFreeTextAnnotation

◆ obj2IInkAnnotation

◆ obj2ILineAnnotation

◆ obj2ILinkAnnotation

◆ obj2IMarkupAnnotation

◆ obj2IPolyAnnotation

◆ obj2IPopupAnnotation

◆ obj2IRedactionAnnotation

◆ obj2IShapeAnnotation

◆ obj2ISoundAnnotation

◆ obj2IStampAnnotation

◆ obj2ITextAnnotation

◆ obj2ITextMarkupAnnotation

◆ obj2IWidgetAnnotation