pdfproperties.h File Reference

Interface of the several wxPdfDocument property classes. More...

#include "wx/pdfdocdef.h"

Classes

class  wxPdfInfo
 Class representing a PDF document information dictionary. More...
class  wxPdfLink
 Class representing internal or external links. More...
class  wxPdfPageLink
 Class representing the sensitive area of links referring to a page. (For internal use only). More...
class  wxPdfAnnotation
 Class representing text annotations. More...
class  wxPdfBookmark
 Class representing bookmarks for defining the document's outline. (For internal use only). More...
class  wxPdfSpotColour
 Class representing spot colors. More...
class  wxPdfColour
 Class representing wxPdfDocument colors. More...
class  wxPdfLineStyle
 Class representing line styles. More...
class  wxPdfCoonsPatchMesh
 Class representing a coons patch mesh. More...
class  wxPdfShape
 Class representing a shape consisting of line and curve segments. More...

Defines

#define wxPDF_BORDER_NONE   0x0000
 Border options.
#define wxPDF_BORDER_LEFT   0x0001
#define wxPDF_BORDER_RIGHT   0x0002
#define wxPDF_BORDER_TOP   0x0004
#define wxPDF_BORDER_BOTTOM   0x0008
#define wxPDF_BORDER_FRAME   0x000F
#define wxPDF_CORNER_NONE   0x0000
 Corner options.
#define wxPDF_CORNER_TOP_LEFT   0x0001
#define wxPDF_CORNER_TOP_RIGHT   0x0002
#define wxPDF_CORNER_BOTTOM_LEFT   0x0004
#define wxPDF_CORNER_BOTTOM_RIGHT   0x0008
#define wxPDF_CORNER_ALL   0x000F
#define wxPDF_STYLE_NOOP   0x0000
 Style options.
#define wxPDF_STYLE_DRAW   0x0001
#define wxPDF_STYLE_FILL   0x0002
#define wxPDF_STYLE_FILLDRAW   0x0003
#define wxPDF_STYLE_DRAWCLOSE   0x0004
#define wxPDF_STYLE_MASK   0x0007
#define wxPDF_FONT_NORMAL   0x0000
 Font decoration options.
#define wxPDF_FONT_UNDERLINE   0x0001
#define wxPDF_FONT_OVERLINE   0x0002
#define wxPDF_FONT_STRIKEOUT   0x0004
#define wxPDF_FONT_DECORATION   0x0007
#define wxPDF_PERMISSION_NONE   0x0000
 Permission options Allow nothing.
#define wxPDF_PERMISSION_PRINT   0x0004
 Allow printing.
#define wxPDF_PERMISSION_MODIFY   0x0008
 Allow modifying.
#define wxPDF_PERMISSION_COPY   0x0010
 Allow text copying.
#define wxPDF_PERMISSION_ANNOT   0x0020
 Allow annotations.
#define wxPDF_PERMISSION_ALL   0x003C
 Allow anything.
#define wxPDF_VIEWER_HIDETOOLBAR   0x0001
 Viewer preferences.
#define wxPDF_VIEWER_HIDEMENUBAR   0x0002
#define wxPDF_VIEWER_HIDEWINDOWUI   0x0004
#define wxPDF_VIEWER_FITWINDOW   0x0008
#define wxPDF_VIEWER_CENTERWINDOW   0x0010
#define wxPDF_VIEWER_DISPLAYDOCTITLE   0x0020

Enumerations

enum  wxPdfEncryptionMethod { wxPDF_ENCRYPTION_RC4V1, wxPDF_ENCRYPTION_RC4V2, wxPDF_ENCRYPTION_AESV2 }
 Encryption methods. More...
enum  wxPdfColourType {
  wxPDF_COLOURTYPE_UNKNOWN, wxPDF_COLOURTYPE_GRAY, wxPDF_COLOURTYPE_RGB, wxPDF_COLOURTYPE_CMYK,
  wxPDF_COLOURTYPE_SPOT
}
 Color types. More...
enum  wxPdfBorderStyle {
  wxPDF_BORDER_SOLID, wxPDF_BORDER_DASHED, wxPDF_BORDER_BEVELED, wxPDF_BORDER_INSET,
  wxPDF_BORDER_UNDERLINE
}
 Form field border styles. More...
enum  wxPdfAlignment {
  wxPDF_ALIGN_LEFT, wxPDF_ALIGN_CENTER, wxPDF_ALIGN_RIGHT, wxPDF_ALIGN_JUSTIFY,
  wxPDF_ALIGN_TOP = wxPDF_ALIGN_LEFT, wxPDF_ALIGN_MIDDLE = wxPDF_ALIGN_CENTER, wxPDF_ALIGN_BOTTOM = wxPDF_ALIGN_RIGHT
}
 Alignment options. More...
enum  wxPdfZoom {
  wxPDF_ZOOM_FULLPAGE, wxPDF_ZOOM_FULLWIDTH, wxPDF_ZOOM_REAL, wxPDF_ZOOM_DEFAULT,
  wxPDF_ZOOM_FACTOR
}
 Zoom options. More...
enum  wxPdfLayout { wxPDF_LAYOUT_CONTINUOUS, wxPDF_LAYOUT_SINGLE, wxPDF_LAYOUT_TWO, wxPDF_LAYOUT_DEFAULT }
 Layout options. More...
enum  wxPdfLineCap { wxPDF_LINECAP_NONE = -1, wxPDF_LINECAP_BUTT = 0, wxPDF_LINECAP_ROUND = 1, wxPDF_LINECAP_SQUARE = 2 }
 Line Cap options. More...
enum  wxPdfLineJoin { wxPDF_LINEJOIN_NONE = -1, wxPDF_LINEJOIN_MITER = 0, wxPDF_LINEJOIN_ROUND = 1, wxPDF_LINEJOIN_BEVEL = 2 }
 Line join options. More...
enum  wxPdfMarker {
  wxPDF_MARKER_CIRCLE, wxPDF_MARKER_SQUARE, wxPDF_MARKER_TRIANGLE_UP, wxPDF_MARKER_TRIANGLE_DOWN,
  wxPDF_MARKER_TRIANGLE_LEFT, wxPDF_MARKER_TRIANGLE_RIGHT, wxPDF_MARKER_DIAMOND, wxPDF_MARKER_PENTAGON_UP,
  wxPDF_MARKER_PENTAGON_DOWN, wxPDF_MARKER_PENTAGON_LEFT, wxPDF_MARKER_PENTAGON_RIGHT, wxPDF_MARKER_STAR,
  wxPDF_MARKER_STAR4, wxPDF_MARKER_PLUS, wxPDF_MARKER_CROSS, wxPDF_MARKER_SUN,
  wxPDF_MARKER_BOWTIE_HORIZONTAL, wxPDF_MARKER_BOWTIE_VERTICAL, wxPDF_MARKER_ASTERISK, wxPDF_MARKER_LAST
}
 Marker symbols. More...
enum  wxPdfLinearGradientType {
  wxPDF_LINEAR_GRADIENT_HORIZONTAL, wxPDF_LINEAR_GRADIENT_VERTICAL, wxPDF_LINEAR_GRADIENT_MIDHORIZONTAL, wxPDF_LINEAR_GRADIENT_MIDVERTICAL,
  wxPDF_LINEAR_GRADIENT_REFLECTION_LEFT, wxPDF_LINEAR_GRADIENT_REFLECTION_RIGHT, wxPDF_LINEAR_GRADIENT_REFLECTION_TOP, wxPDF_LINEAR_GRADIENT_REFLECTION_BOTTOM
}
 Linear gradient types. More...
enum  wxPdfBlendMode {
  wxPDF_BLENDMODE_NORMAL, wxPDF_BLENDMODE_MULTIPLY, wxPDF_BLENDMODE_SCREEN, wxPDF_BLENDMODE_OVERLAY,
  wxPDF_BLENDMODE_DARKEN, wxPDF_BLENDMODE_LIGHTEN, wxPDF_BLENDMODE_COLORDODGE, wxPDF_BLENDMODE_COLORBURN,
  wxPDF_BLENDMODE_HARDLIGHT, wxPDF_BLENDMODE_SOFTLIGHT, wxPDF_BLENDMODE_DIFFERENCE, wxPDF_BLENDMODE_EXCLUSION,
  wxPDF_BLENDMODE_HUE, wxPDF_BLENDMODE_SATURATION, wxPDF_BLENDMODE_COLOR, wxPDF_BLENDMODE_LUMINOSITY
}
enum  wxPdfShapedTextMode { wxPDF_SHAPEDTEXTMODE_ONETIME, wxPDF_SHAPEDTEXTMODE_STRETCHTOFIT, wxPDF_SHAPEDTEXTMODE_REPEAT }
enum  wxPdfSegmentType {
  wxPDF_SEG_UNDEFINED, wxPDF_SEG_MOVETO, wxPDF_SEG_LINETO, wxPDF_SEG_CURVETO,
  wxPDF_SEG_CLOSE
}
 Shape segment types. More...

Functions

bool operator== (const wxPdfColour &a, const wxPdfColour &b)
bool operator!= (const wxPdfColour &a, const wxPdfColour &b)
 WX_DEFINE_USER_EXPORTED_ARRAY_DOUBLE (double, wxPdfArrayDouble, class WXDLLIMPEXP_PDFDOC)
 Class representing double arrays (no standard class in wxWidgets unfortunately).


Detailed Description

Interface of the several wxPdfDocument property classes.


Define Documentation

#define wxPDF_BORDER_BOTTOM   0x0008

#define wxPDF_BORDER_FRAME   0x000F

#define wxPDF_BORDER_LEFT   0x0001

#define wxPDF_BORDER_NONE   0x0000

Border options.

#define wxPDF_BORDER_RIGHT   0x0002

#define wxPDF_BORDER_TOP   0x0004

#define wxPDF_CORNER_ALL   0x000F

#define wxPDF_CORNER_BOTTOM_LEFT   0x0004

#define wxPDF_CORNER_BOTTOM_RIGHT   0x0008

#define wxPDF_CORNER_NONE   0x0000

Corner options.

#define wxPDF_CORNER_TOP_LEFT   0x0001

#define wxPDF_CORNER_TOP_RIGHT   0x0002

#define wxPDF_FONT_DECORATION   0x0007

#define wxPDF_FONT_NORMAL   0x0000

Font decoration options.

#define wxPDF_FONT_OVERLINE   0x0002

#define wxPDF_FONT_STRIKEOUT   0x0004

#define wxPDF_FONT_UNDERLINE   0x0001

#define wxPDF_PERMISSION_ALL   0x003C

Allow anything.

#define wxPDF_PERMISSION_ANNOT   0x0020

Allow annotations.

#define wxPDF_PERMISSION_COPY   0x0010

Allow text copying.

#define wxPDF_PERMISSION_MODIFY   0x0008

Allow modifying.

#define wxPDF_PERMISSION_NONE   0x0000

Permission options Allow nothing.

#define wxPDF_PERMISSION_PRINT   0x0004

Allow printing.

#define wxPDF_STYLE_DRAW   0x0001

#define wxPDF_STYLE_DRAWCLOSE   0x0004

#define wxPDF_STYLE_FILL   0x0002

#define wxPDF_STYLE_FILLDRAW   0x0003

#define wxPDF_STYLE_MASK   0x0007

#define wxPDF_STYLE_NOOP   0x0000

Style options.

#define wxPDF_VIEWER_CENTERWINDOW   0x0010

#define wxPDF_VIEWER_DISPLAYDOCTITLE   0x0020

#define wxPDF_VIEWER_FITWINDOW   0x0008

#define wxPDF_VIEWER_HIDEMENUBAR   0x0002

#define wxPDF_VIEWER_HIDETOOLBAR   0x0001

Viewer preferences.

#define wxPDF_VIEWER_HIDEWINDOWUI   0x0004


Enumeration Type Documentation

enum wxPdfAlignment

Alignment options.

Enumerator:
wxPDF_ALIGN_LEFT 
wxPDF_ALIGN_CENTER 
wxPDF_ALIGN_RIGHT 
wxPDF_ALIGN_JUSTIFY 
wxPDF_ALIGN_TOP 
wxPDF_ALIGN_MIDDLE 
wxPDF_ALIGN_BOTTOM 

enum wxPdfBlendMode

Enumerator:
wxPDF_BLENDMODE_NORMAL 
wxPDF_BLENDMODE_MULTIPLY 
wxPDF_BLENDMODE_SCREEN 
wxPDF_BLENDMODE_OVERLAY 
wxPDF_BLENDMODE_DARKEN 
wxPDF_BLENDMODE_LIGHTEN 
wxPDF_BLENDMODE_COLORDODGE 
wxPDF_BLENDMODE_COLORBURN 
wxPDF_BLENDMODE_HARDLIGHT 
wxPDF_BLENDMODE_SOFTLIGHT 
wxPDF_BLENDMODE_DIFFERENCE 
wxPDF_BLENDMODE_EXCLUSION 
wxPDF_BLENDMODE_HUE 
wxPDF_BLENDMODE_SATURATION 
wxPDF_BLENDMODE_COLOR 
wxPDF_BLENDMODE_LUMINOSITY 

enum wxPdfBorderStyle

Form field border styles.

Enumerator:
wxPDF_BORDER_SOLID 
wxPDF_BORDER_DASHED 
wxPDF_BORDER_BEVELED 
wxPDF_BORDER_INSET 
wxPDF_BORDER_UNDERLINE 

enum wxPdfColourType

Color types.

Enumerator:
wxPDF_COLOURTYPE_UNKNOWN 
wxPDF_COLOURTYPE_GRAY 
wxPDF_COLOURTYPE_RGB 
wxPDF_COLOURTYPE_CMYK 
wxPDF_COLOURTYPE_SPOT 

enum wxPdfEncryptionMethod

Encryption methods.

Enumerator:
wxPDF_ENCRYPTION_RC4V1 
wxPDF_ENCRYPTION_RC4V2 
wxPDF_ENCRYPTION_AESV2 

enum wxPdfLayout

Layout options.

Enumerator:
wxPDF_LAYOUT_CONTINUOUS 
wxPDF_LAYOUT_SINGLE 
wxPDF_LAYOUT_TWO 
wxPDF_LAYOUT_DEFAULT 

enum wxPdfLinearGradientType

Linear gradient types.

Enumerator:
wxPDF_LINEAR_GRADIENT_HORIZONTAL 
wxPDF_LINEAR_GRADIENT_VERTICAL 
wxPDF_LINEAR_GRADIENT_MIDHORIZONTAL 
wxPDF_LINEAR_GRADIENT_MIDVERTICAL 
wxPDF_LINEAR_GRADIENT_REFLECTION_LEFT 
wxPDF_LINEAR_GRADIENT_REFLECTION_RIGHT 
wxPDF_LINEAR_GRADIENT_REFLECTION_TOP 
wxPDF_LINEAR_GRADIENT_REFLECTION_BOTTOM 

enum wxPdfLineCap

Line Cap options.

Enumerator:
wxPDF_LINECAP_NONE 
wxPDF_LINECAP_BUTT 
wxPDF_LINECAP_ROUND 
wxPDF_LINECAP_SQUARE 

enum wxPdfLineJoin

Line join options.

Enumerator:
wxPDF_LINEJOIN_NONE 
wxPDF_LINEJOIN_MITER 
wxPDF_LINEJOIN_ROUND 
wxPDF_LINEJOIN_BEVEL 

enum wxPdfMarker

Marker symbols.

Enumerator:
wxPDF_MARKER_CIRCLE 
wxPDF_MARKER_SQUARE 
wxPDF_MARKER_TRIANGLE_UP 
wxPDF_MARKER_TRIANGLE_DOWN 
wxPDF_MARKER_TRIANGLE_LEFT 
wxPDF_MARKER_TRIANGLE_RIGHT 
wxPDF_MARKER_DIAMOND 
wxPDF_MARKER_PENTAGON_UP 
wxPDF_MARKER_PENTAGON_DOWN 
wxPDF_MARKER_PENTAGON_LEFT 
wxPDF_MARKER_PENTAGON_RIGHT 
wxPDF_MARKER_STAR 
wxPDF_MARKER_STAR4 
wxPDF_MARKER_PLUS 
wxPDF_MARKER_CROSS 
wxPDF_MARKER_SUN 
wxPDF_MARKER_BOWTIE_HORIZONTAL 
wxPDF_MARKER_BOWTIE_VERTICAL 
wxPDF_MARKER_ASTERISK 
wxPDF_MARKER_LAST 

enum wxPdfSegmentType

Shape segment types.

Enumerator:
wxPDF_SEG_UNDEFINED 
wxPDF_SEG_MOVETO 
wxPDF_SEG_LINETO 
wxPDF_SEG_CURVETO 
wxPDF_SEG_CLOSE 

enum wxPdfShapedTextMode

Enumerator:
wxPDF_SHAPEDTEXTMODE_ONETIME 
wxPDF_SHAPEDTEXTMODE_STRETCHTOFIT 
wxPDF_SHAPEDTEXTMODE_REPEAT 

enum wxPdfZoom

Zoom options.

Enumerator:
wxPDF_ZOOM_FULLPAGE 
wxPDF_ZOOM_FULLWIDTH 
wxPDF_ZOOM_REAL 
wxPDF_ZOOM_DEFAULT 
wxPDF_ZOOM_FACTOR 


Function Documentation

bool operator!= ( const wxPdfColour a,
const wxPdfColour b 
)

bool operator== ( const wxPdfColour a,
const wxPdfColour b 
)

WX_DEFINE_USER_EXPORTED_ARRAY_DOUBLE ( double  ,
wxPdfArrayDouble  ,
class  WXDLLIMPEXP_PDFDOC 
)

Class representing double arrays (no standard class in wxWidgets unfortunately).


Generated on Fri Dec 15 21:30:36 2006 for wxPdfDocument by  doxygen 1.5.1-p1