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

#include <interactive.h>

Public Types
enum	eBorderType { eBTSolid , eBTDashed , eBTBeveled , eBTInset , eBTUnderline }
	Types of border. More...

Public Member Functions
	CAnnotationBorder (float inWidth=1.0f/72.0f *96.0f, const eBorderType &inType=eBTSolid, const CEDLVector< float > &inDash=CEDLVector< float >())
	Constructor. More...

Public Attributes
float	width

eBorderType	type
	The type of border.

CEDLVector< float >	dash

Detailed Description

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.

Member Enumeration Documentation

◆ eBorderType

enum JawsMako::CAnnotationBorder::eBorderType

Types of border.

Enumerator
eBTSolid	A solid rectangle surrounding the annotation.
eBTDashed	A dashed rectangle surrounding the annotation.
eBTBeveled	A simulated embossed rectangle that appears to be raised above the surface of the page.
eBTInset	A simulated engraved rectangle that appears to be recessed below the surface of the page.
eBTUnderline	A single line along the bottom of the annotation rectangle.

Constructor & Destructor Documentation

◆ CAnnotationBorder()

JawsMako::CAnnotationBorder::CAnnotationBorder	(	float	inWidth = `1.0f / 72.0f * 96.0f`,
		const eBorderType &	inType = `eBTSolid`,
		const CEDLVector< float > &	inDash = `CEDLVector<float>()`
	)

inline

Constructor.

Parameters

inWidth	Border width. Default width is 1 PDF unit, or 1/72nd of an inch
inType	Border type. Default is eBTSolid
inDash	A vector of floats describing a eBTDashed dash pattern

Member Data Documentation

◆ dash

CEDLVector<float> JawsMako::CAnnotationBorder::dash

If the border type is eBTDashed, this is the dash pattern, expressed in standard JawsMako units (96ths of an inch)

◆ width

float JawsMako::CAnnotationBorder::width

Width of the border in standard JawsMako units (96ths of an inch); a width of zero indicates that the border is not drawn.

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

interactive.h

Public Types

Public Member Functions

Public Attributes