wxPdfDocument 1.2.0
Macros | Enumerations
pdfproperties.h File Reference

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

#include "wx/pdfdocdef.h"

Macros

#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_PERMISSION_NONE   0x0000
 Permission options.
 
#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_FILLFORM   0x0100
 Allow filling forms.
 
#define wxPDF_PERMISSION_EXTRACT   0x0200
 Allow extract text and/or graphics.
 
#define wxPDF_PERMISSION_ASSEMBLE   0x0400
 Allow assemble document.
 
#define wxPDF_PERMISSION_HLPRINT   0x0800
 Allow high resolution print.
 
#define wxPDF_PERMISSION_ALL   0x0F3C
 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
 
#define wxPDF_VIEWER_NOPRINTSCALING   0x0040
 

Enumerations

enum  wxPdfTextRenderMode { wxPDF_TEXT_RENDER_FILL = 0 , wxPDF_TEXT_RENDER_STROKE = 1 , wxPDF_TEXT_RENDER_FILLSTROKE = 2 , wxPDF_TEXT_RENDER_INVISIBLE = 3 }
 Text render mode. More...
 
enum  {
  wxPDF_FONTSTYLE_REGULAR = 0 , wxPDF_FONTSTYLE_ITALIC = 1 << 0 , wxPDF_FONTSTYLE_BOLD = 1 << 1 , wxPDF_FONTSTYLE_BOLDITALIC ,
  wxPDF_FONTSTYLE_UNDERLINE = 1 << 2 , wxPDF_FONTSTYLE_OVERLINE = 1 << 3 , wxPDF_FONTSTYLE_STRIKEOUT = 1 << 4 , wxPDF_FONTSTYLE_DECORATION_MASK ,
  wxPDF_FONTSTYLE_MASK
}
 Font style flags. More...
 
enum  wxPdfEncryptionMethod {
  wxPDF_ENCRYPTION_RC4V1 , wxPDF_ENCRYPTION_RC4V2 , wxPDF_ENCRYPTION_AESV2 , wxPDF_ENCRYPTION_AESV3 ,
  wxPDF_ENCRYPTION_AESV3R6
}
 Encryption methods. More...
 
enum  wxPdfPageBox {
  wxPDF_PAGEBOX_MEDIABOX , wxPDF_PAGEBOX_CROPBOX , wxPDF_PAGEBOX_BLEEDBOX , wxPDF_PAGEBOX_TRIMBOX ,
  wxPDF_PAGEBOX_ARTBOX
}
 Page box 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  wxPdfPaperHandling { wxPDF_PAPERHANDLING_DEFAULT , wxPDF_PAPERHANDLING_SIMPLEX , wxPDF_PAPERHANDLING_DUPLEX_FLIP_SHORT_EDGE , wxPDF_PAPERHANDLING_DUPLEX_FLIP_LONG_EDGE }
 Paper handling 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  wxPdfPatternStyle {
  wxPDF_PATTERNSTYLE_NONE , wxPDF_PATTERNSTYLE_IMAGE , wxPDF_PATTERNSTYLE_TEMPLATE , wxPDF_PATTERNSTYLE_FIRST_HATCH ,
  wxPDF_PATTERNSTYLE_BDIAGONAL_HATCH = wxPDF_PATTERNSTYLE_FIRST_HATCH , wxPDF_PATTERNSTYLE_CROSSDIAG_HATCH , wxPDF_PATTERNSTYLE_FDIAGONAL_HATCH , wxPDF_PATTERNSTYLE_CROSS_HATCH ,
  wxPDF_PATTERNSTYLE_HORIZONTAL_HATCH , wxPDF_PATTERNSTYLE_VERTICAL_HATCH , wxPDF_PATTERNSTYLE_HERRINGBONE_HATCH , wxPDF_PATTERNSTYLE_BASKETWEAVE_HATCH ,
  wxPDF_PATTERNSTYLE_BRICK_HATCH , wxPDF_PATTERNSTYLE_LAST_HATCH = wxPDF_PATTERNSTYLE_BRICK_HATCH
}
 Pattern styles. 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  wxPdfXConformanceType {
  wxPDF_PDFXNONE , wxPDF_PDFX1A2001 , wxPDF_PDFX32002 , wxPDF_PDFA1A ,
  wxPDF_PDFA1B
}
 PDF/X conformance. More...
 
enum  wxPdfRunDirection { wxPDF_RUN_DIRECTION_DEFAULT , wxPDF_RUN_DIRECTION_NO_BIDI , wxPDF_RUN_DIRECTION_LTR , wxPDF_RUN_DIRECTION_RTL }
 Run direction of text. More...
 

Detailed Description

Interface of the several wxPdfDocument property classes.

Macro Definition Documentation

◆ wxPDF_BORDER_BOTTOM

#define wxPDF_BORDER_BOTTOM   0x0008

◆ wxPDF_BORDER_FRAME

#define wxPDF_BORDER_FRAME   0x000F

◆ wxPDF_BORDER_LEFT

#define wxPDF_BORDER_LEFT   0x0001

◆ wxPDF_BORDER_NONE

#define wxPDF_BORDER_NONE   0x0000

Border options.

◆ wxPDF_BORDER_RIGHT

#define wxPDF_BORDER_RIGHT   0x0002

◆ wxPDF_BORDER_TOP

#define wxPDF_BORDER_TOP   0x0004

◆ wxPDF_CORNER_ALL

#define wxPDF_CORNER_ALL   0x000F

◆ wxPDF_CORNER_BOTTOM_LEFT

#define wxPDF_CORNER_BOTTOM_LEFT   0x0004

◆ wxPDF_CORNER_BOTTOM_RIGHT

#define wxPDF_CORNER_BOTTOM_RIGHT   0x0008

◆ wxPDF_CORNER_NONE

#define wxPDF_CORNER_NONE   0x0000

Corner options.

◆ wxPDF_CORNER_TOP_LEFT

#define wxPDF_CORNER_TOP_LEFT   0x0001

◆ wxPDF_CORNER_TOP_RIGHT

#define wxPDF_CORNER_TOP_RIGHT   0x0002

◆ wxPDF_PERMISSION_ALL

#define wxPDF_PERMISSION_ALL   0x0F3C

Allow anything.

◆ wxPDF_PERMISSION_ANNOT

#define wxPDF_PERMISSION_ANNOT   0x0020

Allow annotations.

◆ wxPDF_PERMISSION_ASSEMBLE

#define wxPDF_PERMISSION_ASSEMBLE   0x0400

Allow assemble document.

◆ wxPDF_PERMISSION_COPY

#define wxPDF_PERMISSION_COPY   0x0010

Allow text copying.

◆ wxPDF_PERMISSION_EXTRACT

#define wxPDF_PERMISSION_EXTRACT   0x0200

Allow extract text and/or graphics.

◆ wxPDF_PERMISSION_FILLFORM

#define wxPDF_PERMISSION_FILLFORM   0x0100

Allow filling forms.

◆ wxPDF_PERMISSION_HLPRINT

#define wxPDF_PERMISSION_HLPRINT   0x0800

Allow high resolution print.

◆ wxPDF_PERMISSION_MODIFY

#define wxPDF_PERMISSION_MODIFY   0x0008

Allow modifying.

◆ wxPDF_PERMISSION_NONE

#define wxPDF_PERMISSION_NONE   0x0000

Permission options.

Allow nothing

◆ wxPDF_PERMISSION_PRINT

#define wxPDF_PERMISSION_PRINT   0x0004

Allow printing.

◆ wxPDF_STYLE_DRAW

#define wxPDF_STYLE_DRAW   0x0001

◆ wxPDF_STYLE_DRAWCLOSE

#define wxPDF_STYLE_DRAWCLOSE   0x0004

◆ wxPDF_STYLE_FILL

#define wxPDF_STYLE_FILL   0x0002

◆ wxPDF_STYLE_FILLDRAW

#define wxPDF_STYLE_FILLDRAW   0x0003

◆ wxPDF_STYLE_MASK

#define wxPDF_STYLE_MASK   0x0007

◆ wxPDF_STYLE_NOOP

#define wxPDF_STYLE_NOOP   0x0000

Style options.

◆ wxPDF_VIEWER_CENTERWINDOW

#define wxPDF_VIEWER_CENTERWINDOW   0x0010

◆ wxPDF_VIEWER_DISPLAYDOCTITLE

#define wxPDF_VIEWER_DISPLAYDOCTITLE   0x0020

◆ wxPDF_VIEWER_FITWINDOW

#define wxPDF_VIEWER_FITWINDOW   0x0008

◆ wxPDF_VIEWER_HIDEMENUBAR

#define wxPDF_VIEWER_HIDEMENUBAR   0x0002

◆ wxPDF_VIEWER_HIDETOOLBAR

#define wxPDF_VIEWER_HIDETOOLBAR   0x0001

Viewer preferences.

◆ wxPDF_VIEWER_HIDEWINDOWUI

#define wxPDF_VIEWER_HIDEWINDOWUI   0x0004

◆ wxPDF_VIEWER_NOPRINTSCALING

#define wxPDF_VIEWER_NOPRINTSCALING   0x0040

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Font style flags.

Enumerator
wxPDF_FONTSTYLE_REGULAR 
wxPDF_FONTSTYLE_ITALIC 
wxPDF_FONTSTYLE_BOLD 
wxPDF_FONTSTYLE_BOLDITALIC 
wxPDF_FONTSTYLE_UNDERLINE 
wxPDF_FONTSTYLE_OVERLINE 
wxPDF_FONTSTYLE_STRIKEOUT 
wxPDF_FONTSTYLE_DECORATION_MASK 

Mask of decoration styles.

wxPDF_FONTSTYLE_MASK 

◆ 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 

◆ 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 

◆ wxPdfBorderStyle

Form field border styles.

Enumerator
wxPDF_BORDER_SOLID 
wxPDF_BORDER_DASHED 
wxPDF_BORDER_BEVELED 
wxPDF_BORDER_INSET 
wxPDF_BORDER_UNDERLINE 

◆ wxPdfEncryptionMethod

Encryption methods.

Enumerator
wxPDF_ENCRYPTION_RC4V1 
wxPDF_ENCRYPTION_RC4V2 
wxPDF_ENCRYPTION_AESV2 
wxPDF_ENCRYPTION_AESV3 
wxPDF_ENCRYPTION_AESV3R6 

◆ wxPdfLayout

Layout options.

Enumerator
wxPDF_LAYOUT_CONTINUOUS 
wxPDF_LAYOUT_SINGLE 
wxPDF_LAYOUT_TWO 
wxPDF_LAYOUT_DEFAULT 

◆ 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 

◆ 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 

◆ wxPdfPageBox

Page box types.

Enumerator
wxPDF_PAGEBOX_MEDIABOX 
wxPDF_PAGEBOX_CROPBOX 
wxPDF_PAGEBOX_BLEEDBOX 
wxPDF_PAGEBOX_TRIMBOX 
wxPDF_PAGEBOX_ARTBOX 

◆ wxPdfPaperHandling

Paper handling options.

Enumerator
wxPDF_PAPERHANDLING_DEFAULT 
wxPDF_PAPERHANDLING_SIMPLEX 
wxPDF_PAPERHANDLING_DUPLEX_FLIP_SHORT_EDGE 
wxPDF_PAPERHANDLING_DUPLEX_FLIP_LONG_EDGE 

◆ wxPdfPatternStyle

Pattern styles.

Enumerator
wxPDF_PATTERNSTYLE_NONE 
wxPDF_PATTERNSTYLE_IMAGE 
wxPDF_PATTERNSTYLE_TEMPLATE 
wxPDF_PATTERNSTYLE_FIRST_HATCH 
wxPDF_PATTERNSTYLE_BDIAGONAL_HATCH 
wxPDF_PATTERNSTYLE_CROSSDIAG_HATCH 
wxPDF_PATTERNSTYLE_FDIAGONAL_HATCH 
wxPDF_PATTERNSTYLE_CROSS_HATCH 
wxPDF_PATTERNSTYLE_HORIZONTAL_HATCH 
wxPDF_PATTERNSTYLE_VERTICAL_HATCH 
wxPDF_PATTERNSTYLE_HERRINGBONE_HATCH 
wxPDF_PATTERNSTYLE_BASKETWEAVE_HATCH 
wxPDF_PATTERNSTYLE_BRICK_HATCH 
wxPDF_PATTERNSTYLE_LAST_HATCH 

◆ wxPdfRunDirection

Run direction of text.

Enumerator
wxPDF_RUN_DIRECTION_DEFAULT 
wxPDF_RUN_DIRECTION_NO_BIDI 
wxPDF_RUN_DIRECTION_LTR 
wxPDF_RUN_DIRECTION_RTL 

◆ wxPdfShapedTextMode

Enumerator
wxPDF_SHAPEDTEXTMODE_ONETIME 
wxPDF_SHAPEDTEXTMODE_STRETCHTOFIT 
wxPDF_SHAPEDTEXTMODE_REPEAT 

◆ wxPdfTextRenderMode

Text render mode.

Enumerator
wxPDF_TEXT_RENDER_FILL 
wxPDF_TEXT_RENDER_STROKE 
wxPDF_TEXT_RENDER_FILLSTROKE 
wxPDF_TEXT_RENDER_INVISIBLE 

◆ wxPdfXConformanceType

PDF/X conformance.

Enumerator
wxPDF_PDFXNONE 
wxPDF_PDFX1A2001 
wxPDF_PDFX32002 
wxPDF_PDFA1A 
wxPDF_PDFA1B 

◆ wxPdfZoom

enum wxPdfZoom

Zoom options.

Enumerator
wxPDF_ZOOM_FULLPAGE 
wxPDF_ZOOM_FULLWIDTH 
wxPDF_ZOOM_REAL 
wxPDF_ZOOM_DEFAULT 
wxPDF_ZOOM_FACTOR