wxPdfDocument 0.9.2
|
Class representing a PDF document. More...
#include <pdfdocument.h>
Public Member Functions | |
wxPdfDocument (int orientation=wxPORTRAIT, const wxString &unit=wxString(wxT("mm")), wxPaperSize format=wxPAPER_A4) | |
Constructor. | |
wxPdfDocument (int orientation, double pageWidth, double pageHeight, const wxString &unit=wxString(wxT("mm"))) | |
virtual | ~wxPdfDocument () |
virtual void | SetProtection (int permissions, const wxString &userPassword=wxEmptyString, const wxString &ownerPassword=wxEmptyString, wxPdfEncryptionMethod encryptionMethod=wxPDF_ENCRYPTION_RC4V1, int keyLength=0) |
Set permissions as well as user and owner passwords. | |
virtual void | SetImageScale (double scale) |
Set the image scale. | |
virtual double | GetImageScale () |
Returns the image scale. | |
virtual double | GetPageWidth () |
Returns the page width in units. | |
virtual double | GetPageHeight () |
Returns the page height in units. | |
virtual double | GetBreakMargin () |
Returns the page break margin. | |
virtual double | GetScaleFactor () |
Returns the scale factor (number of points in user unit). | |
virtual void | SetMargins (double left, double top, double right=-1) |
Defines the left, top and right margins. | |
virtual void | SetLeftMargin (double margin) |
Defines the left margin. | |
virtual double | GetLeftMargin () |
Returns the left margin. | |
virtual void | SetTopMargin (double margin) |
Defines the top margin. | |
virtual double | GetTopMargin () |
Returns the top margin. | |
virtual void | SetRightMargin (double margin) |
Defines the right margin. | |
virtual double | GetRightMargin () |
Returns the right margin. | |
virtual void | SetCellMargin (double margin) |
Defines the cell margin. | |
virtual double | GetCellMargin () |
Returns the cell margin. | |
virtual void | SetLineHeight (double height) |
Sets the height of a text line. | |
virtual double | GetLineHeight () |
Returns the height of a text line. | |
virtual void | SetAutoPageBreak (bool autoPageBreak, double margin=0) |
Enables or disables the automatic page breaking mode. | |
virtual void | SetDisplayMode (wxPdfZoom zoom, wxPdfLayout layout=wxPDF_LAYOUT_CONTINUOUS, double zoomFactor=100.) |
Defines the way the document is to be displayed by the viewer. | |
virtual void | SetKerning (bool kerning) |
Enable or disable kerning. | |
virtual void | SetCompression (bool compress) |
Activates or deactivates page compression. | |
virtual void | SetViewerPreferences (int preferences=0) |
Defines the viewer preferences. | |
virtual void | SetTitle (const wxString &title) |
Defines the title of the document. | |
virtual void | SetSubject (const wxString &subject) |
Defines the subject of the document. | |
virtual void | SetAuthor (const wxString &author) |
Defines the author of the document. | |
virtual void | SetKeywords (const wxString &keywords) |
Associates keywords with the document,. | |
virtual void | SetCreator (const wxString &creator) |
Defines the creator of the document. | |
virtual void | AliasNbPages (const wxString &alias=wxString(wxT("{nb}"))) |
Defines an alias for the total number of pages. | |
virtual void | Open () |
This method begins the generation of the PDF document. | |
virtual void | Close () |
Terminates the PDF document. | |
virtual void | AddPage (int orientation=-1) |
Adds a new page to the document. | |
virtual void | AddPage (int orientation, wxPaperSize format) |
virtual void | AddPage (int orientation, double pageWidth, double pageHeight) |
virtual void | Header () |
This method is used to render the page header. | |
virtual void | Footer () |
This method is used to render the page footer. | |
virtual bool | IsInFooter () |
Returns whether footer output is in progress. | |
virtual int | PageNo () |
Returns the current page number. | |
virtual void | AddSpotColour (const wxString &name, double cyan, double magenta, double yellow, double black) |
Add spot colour. | |
virtual bool | AddPattern (const wxString &patternName, const wxImage &image, double width, double height) |
Add an image pattern. | |
virtual void | SetDrawColour (const unsigned char grayscale) |
Defines the colour used for all drawing operations. | |
virtual void | SetDrawColour (const wxColour &colour) |
Defines the colour used for all drawing operations. | |
virtual void | SetDrawColour (const wxPdfColour &colour) |
Defines the colour used for all drawing operations. | |
virtual void | SetDrawColour (const unsigned char red, const unsigned char green, const unsigned char blue) |
Defines the colour used for all drawing operations. | |
virtual void | SetDrawColour (double cyan, double magenta, double yellow, double black) |
Defines the colour used for all drawing operations. | |
virtual void | SetDrawColour (const wxString &name, double tint=100) |
Defines the spot colour used for all drawing operations. | |
virtual void | SetDrawPattern (const wxString &name) |
Defines the pattern used for all drawing operations. | |
virtual const wxPdfColour | GetDrawColour () |
Gets the colour used for all drawing operations. | |
virtual void | SetFillColour (const unsigned char grayscale) |
Defines the colour used for all filling operations. | |
virtual void | SetFillColour (const wxColour &colour) |
Defines the colour used for all filling operations. | |
virtual void | SetFillColour (const wxPdfColour &colour) |
Defines the colour used for all filling operations. | |
virtual void | SetFillColour (const unsigned char red, const unsigned char green, const unsigned char blue) |
Defines the colour used for all filling operations. | |
virtual void | SetFillColour (double cyan, double magenta, double yellow, double black) |
Defines the colour used for all filling operations. | |
virtual void | SetFillColour (const wxString &name, double tint=100) |
Defines the spot colour used for all filling operations. | |
virtual void | SetFillPattern (const wxString &name) |
Defines the pattern used for all filling operations. | |
virtual const wxPdfColour | GetPatternColour (const wxString &patternName) |
Gets the named pattern as a colour. | |
virtual const wxPdfColour | GetFillColour () |
Gets the colour used for all filling operations. | |
virtual void | SetTextColour (const unsigned char grayscale) |
Defines the colour used for text. | |
virtual void | SetTextColour (const wxColour &colour) |
Defines the colour used for text. | |
virtual void | SetTextColour (const wxPdfColour &colour) |
Defines the colour used for text. | |
virtual void | SetTextColour (const unsigned char red, const unsigned char green, const unsigned char blue) |
Defines the colour used for text. | |
virtual void | SetTextColour (double cyan, double magenta, double yellow, double black) |
Defines the colour used for text. | |
virtual void | SetTextColour (const wxString &name, double tint=100) |
Defines the spot colour used for text. | |
virtual void | SetTextPattern (const wxString &name) |
Defines the pattern used for text output. | |
virtual const wxPdfColour | GetTextColour () |
Gets the colour used for text output. | |
virtual void | SetTextRenderMode (wxPdfTextRenderMode mode=wxPDF_TEXT_RENDER_FILL) |
Sets the text render mode. | |
virtual wxPdfTextRenderMode | GetTextRenderMode () const |
Returns the text render mode. | |
virtual double | GetStringWidth (const wxString &s) |
Returns the length of a string in user unit. | |
virtual void | SetLineWidth (double width) |
Defines the line width. | |
virtual double | GetLineWidth () |
Gets the current line width. | |
virtual void | SetLineStyle (const wxPdfLineStyle &linestyle) |
Sets line style. | |
virtual const wxPdfLineStyle & | GetLineStyle () |
Get current line style. | |
virtual void | SetFillingRule (int rule=wxWINDING_RULE) |
Set the filling rule. | |
virtual int | GetFillingRule () |
Get the current filling rule. | |
virtual void | Line (double x1, double y1, double x2, double y2) |
Draws a line between two points. | |
virtual void | Arrow (double x1, double y1, double x2, double y2, double linewidth, double height, double width) |
Draws an arrow line between two points. | |
virtual void | Rect (double x, double y, double w, double h, int style=wxPDF_STYLE_DRAW) |
Outputs a rectangle. | |
virtual void | RoundedRect (double x, double y, double w, double h, double r, int roundCorner=wxPDF_CORNER_ALL, int style=wxPDF_STYLE_DRAW) |
Draws a rounded rectangle. | |
virtual void | Curve (double x0, double y0, double x1, double y1, double x2, double y2, double x3, double y3, int style=wxPDF_STYLE_DRAW) |
Draws a Bezier curve. | |
virtual void | Ellipse (double x0, double y0, double rx, double ry=0, double angle=0, double astart=0, double afinish=360, int style=wxPDF_STYLE_DRAW, int nSeg=8, bool doSector=false) |
Draws an ellipse. | |
virtual void | Circle (double x0, double y0, double r, double astart=0, double afinish=360, int style=wxPDF_STYLE_DRAW, int nSeg=8) |
Draws a circle. | |
virtual void | Sector (double x0, double y0, double r, double astart, double afinish, int style=wxPDF_STYLE_FILLDRAW, bool clockwise=true, double origin=90.) |
Draws a sector. | |
virtual void | Polygon (const wxPdfArrayDouble &x, const wxPdfArrayDouble &y, int style=wxPDF_STYLE_DRAW) |
Draws a polygon. | |
virtual void | RegularPolygon (double x0, double y0, double r, int ns, double angle=0, bool circle=false, int style=wxPDF_STYLE_DRAW, int circleStyle=wxPDF_STYLE_DRAW, const wxPdfLineStyle &circleLineStyle=wxPdfLineStyle(), const wxPdfColour &circleFillColour=wxPdfColour()) |
Draws a regular polygon. | |
virtual void | StarPolygon (double x0, double y0, double r, int nv, int ng, double angle=0, bool circle=false, int style=wxPDF_STYLE_DRAW, int circleStyle=wxPDF_STYLE_DRAW, const wxPdfLineStyle &circleLineStyle=wxPdfLineStyle(), const wxPdfColour &circleFillColour=wxPdfColour()) |
Draws a star polygon. | |
virtual void | BezierSpline (const wxPdfArrayDouble &x, const wxPdfArrayDouble &y, int style) |
Draws a Bezier spline through a list of points. | |
virtual void | ClosedBezierSpline (const wxPdfArrayDouble &x, const wxPdfArrayDouble &y, int style) |
Draws a closed Bezier spline through a list of points. | |
virtual void | Shape (const wxPdfShape &shape, int style=wxPDF_STYLE_DRAW) |
Draws a shape. | |
virtual void | Rotate (double angle, double x=-1, double y=-1) |
Performs a rotation around a given center. | |
virtual void | SetFontSubsetting (bool fontSubsetting=true) |
Sets the font embedding mode. | |
virtual bool | GetFontSubsetting () const |
Returns the font embedding mode. | |
virtual bool | AddFont (const wxString &family, const wxString &style=wxEmptyString, const wxString &file=wxEmptyString) |
Imports a TrueType, TrueTypeUnicode or Type1 font and makes it available. | |
virtual bool | AddFontCJK (const wxString &family) |
Imports a CJK (Chinese, Japanese or Korean) font and makes it available. | |
virtual bool | SetFont (const wxString &family, const wxString &style=wxEmptyString, double size=0) |
Sets the font used to print character strings. | |
virtual bool | SetFont (const wxString &family, int style, double size=0) |
Sets the font used to print character strings. | |
virtual bool | SetFont (const wxPdfFont &font, int style=wxPDF_FONTSTYLE_REGULAR, double size=0) |
Sets the font used to print character strings based on a wxFont object. | |
virtual bool | SetFont (const wxFont &font) |
Sets the font used to print character strings based on a wxFont object. | |
virtual void | SetFontSize (double size) |
Defines the size of the current font. | |
virtual wxPdfFont | GetCurrentFont () const |
Returns the current font. | |
virtual const wxPdfFontDescription & | GetFontDescription () const |
Returns the current font description instance. | |
virtual const wxString | GetFontFamily () |
Gets the font family of the current font. | |
virtual const wxString | GetFontStyle () const |
Gets the style of the current font. | |
virtual int | GetFontStyles () const |
Gets the style of the current font. | |
virtual double | GetFontSize () const |
Gets the size of the current font. | |
virtual int | AddLink () |
Creates a new internal link and returns its identifier. | |
virtual bool | SetLink (int link, double y=0., int page=-1) |
Defines the page and position a link points to. | |
virtual void | Link (double x, double y, double w, double h, const wxPdfLink &link) |
Puts a link on a rectangular area of the page. | |
virtual void | Bookmark (const wxString &txt, int level=0, double y=0) |
Adds a bookmark to the document outline. | |
virtual void | Text (double x, double y, const wxString &txt) |
Prints a character string. | |
virtual void | RotatedText (double x, double y, const wxString &txt, double angle) |
Prints a rotated text string. | |
virtual bool | AcceptPageBreak () |
Whenever a page break condition is met,. | |
virtual void | Cell (double w, double h=0., const wxString &txt=wxEmptyString, int border=wxPDF_BORDER_NONE, int ln=0, int align=wxPDF_ALIGN_LEFT, int fill=0, const wxPdfLink &link=wxPdfLink(-1)) |
Prints a cell (rectangular area) with optional borders, background colour and character string. | |
virtual int | MultiCell (double w, double h, const wxString &txt, int border=0, int align=wxPDF_ALIGN_JUSTIFY, int fill=0, int maxline=0) |
This method allows printing text with line breaks. | |
virtual int | LineCount (double w, const wxString &txt) |
This method counts the number of lines a text would occupy in respect to a given maximal width. | |
virtual int | TextBox (double w, double h, const wxString &txt, int halign=wxPDF_ALIGN_JUSTIFY, int valign=wxPDF_ALIGN_TOP, int border=0, int fill=0) |
This method counts the number of lines a text will occupy in respect to a given maximal width. | |
virtual void | Write (double h, const wxString &txt, const wxPdfLink &link=wxPdfLink(-1)) |
This method prints text from the current position. | |
virtual void | WriteCell (double h, const wxString &txt, int border=wxPDF_BORDER_NONE, int fill=0, const wxPdfLink &link=wxPdfLink(-1)) |
This method prints text with cell attributes from the current position. | |
virtual bool | WriteGlyphArray (wxPdfArrayDouble &x, wxPdfArrayDouble &y, wxPdfArrayUint32 &glyphs) |
Prints an array of glyphs identified by glyph numbers from the current position. | |
virtual bool | Image (const wxString &file, double x, double y, double w=0, double h=0, const wxString &mimeType=wxEmptyString, const wxPdfLink &link=wxPdfLink(-1), int maskImage=0) |
Puts an image in the page. | |
virtual bool | Image (const wxString &name, const wxImage &image, double x, double y, double w=0, double h=0, const wxPdfLink &link=wxPdfLink(-1), int maskImage=0) |
virtual bool | Image (const wxString &name, wxInputStream &stream, const wxString &mimeType, double x, double y, double w=0, double h=0, const wxPdfLink &link=wxPdfLink(-1), int maskImage=0) |
virtual int | ImageMask (const wxString &file, const wxString &mimeType=wxEmptyString) |
virtual int | ImageMask (const wxString &name, const wxImage &image) |
virtual int | ImageMask (const wxString &name, wxInputStream &stream, const wxString &mimeType) |
virtual void | RotatedImage (const wxString &file, double x, double y, double w, double h, double angle, const wxString &type=wxEmptyString, const wxPdfLink &link=wxPdfLink(-1), int maskImage=0) |
Puts a rotated image in the page. | |
virtual void | Ln (double h=-1) |
Performs a line break. | |
virtual double | GetX () |
Returns the abscissa of the current position. | |
virtual void | SetX (double x) |
Defines the abscissa of the current position. | |
virtual double | GetY () |
Returns the ordinate of the current position. | |
virtual void | SetY (double y) |
Moves the current abscissa back to the left margin and sets the ordinate. | |
virtual void | SetXY (double x, double y) |
Defines the abscissa and ordinate of the current position. | |
virtual void | SaveAsFile (const wxString &name=wxEmptyString) |
Saves the document to a file on disk. | |
virtual const wxMemoryOutputStream & | CloseAndGetBuffer () |
Closes the document and returns the memory buffer containing the document. | |
virtual void | ClippingText (double x, double y, const wxString &txt, bool outline=false) |
Define text as clipping area. | |
virtual void | ClippingRect (double x, double y, double w, double h, bool outline=false) |
Define rectangle as clipping area. | |
virtual void | ClippingEllipse (double x, double y, double rx, double ry=0, bool outline=false) |
Define ellipse as clipping area. | |
virtual void | ClippingPolygon (const wxPdfArrayDouble &x, const wxPdfArrayDouble &y, bool outline=false) |
Define polygon as clipping area. | |
virtual void | ClippingPath () |
Start defining a clipping path. | |
virtual void | MoveTo (double x, double y) |
Begin a new subpath. | |
virtual void | LineTo (double x, double y) |
Append a straight line segment to the current (sub)path. | |
virtual void | CurveTo (double x1, double y1, double x2, double y2, double x3, double y3) |
Append a cubic Bezier curve to the current (sub)path. | |
virtual void | EndPath (int style=wxPDF_STYLE_DRAW) |
End a graphics path. | |
virtual void | ClosePath (int style=wxPDF_STYLE_NOOP) |
Close the clipping path. | |
virtual void | ClippingPath (const wxPdfShape &shape, int style=wxPDF_STYLE_NOOP) |
Define clipping area using a shape. | |
virtual void | UnsetClipping () |
Remove clipping area. | |
virtual void | ClippedCell (double w, double h=0., const wxString &txt=wxEmptyString, int border=wxPDF_BORDER_NONE, int ln=0, int align=wxPDF_ALIGN_LEFT, int fill=0, const wxPdfLink &link=wxPdfLink(-1)) |
Prints a cell clipped to a rectangular area. | |
virtual void | StartTransform () |
Enters a transformation environment. | |
virtual bool | ScaleX (double sx, double x=-1, double y=-1) |
Performs scaling in X direction only. | |
virtual bool | ScaleY (double sy, double x=-1, double y=-1) |
Performs scaling in Y direction only. | |
virtual bool | ScaleXY (double s, double x=-1, double y=-1) |
Performs equal scaling in X and Y direction. | |
virtual bool | Scale (double sx, double sy, double x=-1, double y=-1) |
Performs scaling in X and Y direction. | |
virtual void | MirrorH (double x=-1) |
Performs a horizontal mirroring transformation. | |
virtual void | MirrorV (double y=-1) |
Performs a vertical mirroring transformation. | |
virtual void | TranslateX (double tx) |
Moves the X origin. | |
virtual void | TranslateY (double ty) |
Moves the Y origin. | |
virtual void | Translate (double tx, double ty) |
Moves the origin. | |
virtual bool | SkewX (double xAngle, double x=-1, double y=-1) |
Performs a skewing in both X direction only. | |
virtual bool | SkewY (double yAngle, double x=-1, double y=-1) |
Performs a skewing in Y direction only. | |
virtual bool | Skew (double xAngle, double yAngle, double x=-1, double y=-1) |
Performs a skewing in both X and Y directions. | |
virtual void | Transform (double a, double b, double c, double d, double tx, double ty) |
virtual void | StopTransform () |
Leaves a transformation environment. | |
virtual int | SetAlpha (double lineAlpha=1, double fillAlpha=1, wxPdfBlendMode blendMode=wxPDF_BLENDMODE_NORMAL) |
Sets alpha values and blend mode. | |
virtual void | SetAlphaState (int alphaState) |
Sets a previously defined alpha state. | |
virtual int | LinearGradient (const wxPdfColour &col1, const wxPdfColour &col2, wxPdfLinearGradientType gradientType=wxPDF_LINEAR_GRADIENT_HORIZONTAL) |
Defines a linear gradient shading. | |
virtual int | AxialGradient (const wxPdfColour &col1, const wxPdfColour &col2, double x1=0, double y1=0, double x2=1, double y2=0, double intexp=1) |
Defines a axial gradient shading. | |
virtual int | MidAxialGradient (const wxPdfColour &col1, const wxPdfColour &col2, double x1=0, double y1=0, double x2=1, double y2=0, double midpoint=0.5, double intexp=1) |
Defines a axial gradient shading. | |
virtual int | RadialGradient (const wxPdfColour &col1, const wxPdfColour &col2, double x1=0.5, double y1=0.5, double r1=0, double x2=0.5, double y2=0.5, double r2=1, double intexp=1) |
Defines a radial gradient shading. | |
virtual int | CoonsPatchGradient (const wxPdfCoonsPatchMesh &mesh, double minCoord=0, double maxCoord=1) |
Defines a coons patch mesh gradient shading. | |
virtual void | SetFillGradient (double x, double y, double w, double h, int gradient) |
Paints a gradient shading to rectangular area. | |
virtual void | Marker (double x, double y, wxPdfMarker markerType, double size) |
Draws a graphical marker symbol. | |
virtual void | Annotate (double x, double y, const wxString &text) |
Adds a text annotation. | |
virtual void | AppendJavascript (const wxString &javascript) |
Appends Javascript. | |
virtual void | WriteXml (const wxString &str) |
Prints a string containing simple XML markup. | |
virtual void | CheckBox (const wxString &name, double width, bool checked=false) |
Adds a check box field at the current position. | |
virtual void | CheckBox (const wxString &name, double x, double y, double width, bool checked=false) |
Adds a check box field. | |
virtual void | ComboBox (const wxString &name, double width, double height, const wxArrayString &values) |
Adds a combo box field at the current position. | |
virtual void | ComboBox (const wxString &name, double x, double y, double width, double height, const wxArrayString &values) |
Adds a combo box field. | |
virtual void | PushButton (const wxString &name, double width, double height, const wxString &caption, const wxString &action) |
Adds a push button at the current position. | |
virtual void | PushButton (const wxString &name, double x, double y, double width, double height, const wxString &caption, const wxString &action) |
Adds a push button. | |
virtual void | RadioButton (const wxString &group, const wxString &name, double width) |
Adds a radio button at the current position. | |
virtual void | RadioButton (const wxString &group, const wxString &name, double x, double y, double width) |
Adds a radio button. | |
virtual void | TextField (const wxString &name, double width, double height, const wxString &value=wxEmptyString, bool multiline=false) |
Adds a text field at the current position. | |
virtual void | TextField (const wxString &name, double x, double y, double width, double height, const wxString &value=wxEmptyString, bool multiline=false) |
Adds a text field. | |
virtual void | SetFormColours (const wxPdfColour &borderColour=wxPdfColour(), const wxPdfColour &backgroundColour=wxPdfColour(250), const wxPdfColour &textColour=wxPdfColour()) |
Sets colours for form fields. | |
virtual void | SetFormBorderStyle (wxPdfBorderStyle borderStyle=wxPDF_BORDER_SOLID, double borderWidth=-1) |
Sets the border style for form fields. | |
virtual int | BeginTemplate (double x=0, double y=0, double width=0, double height=0) |
Starts a new Template. | |
virtual int | EndTemplate () |
Terminates a template. | |
virtual void | GetTemplateSize (int templateId, double &width, double &height) |
Get the calculated size of a template. | |
virtual void | UseTemplate (int templateId, double x=-1, double y=-1, double width=0, double height=0) |
Uses a template in current page or in another template. | |
virtual int | SetSourceFile (const wxString &filename, const wxString &password=wxEmptyString) |
Sets a source file for the external template feature. | |
virtual bool | GetSourceInfo (wxPdfInfo &info) |
Gets the document information dictionary of the current external PDF document. | |
virtual int | ImportPage (unsigned int pageno, wxPdfPageBox pageBox=wxPDF_PAGEBOX_ARTBOX) |
Imports a page from an external PDF document. | |
virtual void | GetTemplateBBox (int templateId, double &x, double &y, double &width, double &height) |
Gets the bounding box of a template. | |
virtual void | SetTemplateBBox (int templateId, double x, double y, double width, double height) |
Sets the bounding box of a template. | |
virtual void | ShapedText (const wxPdfShape &shape, const wxString &text, wxPdfShapedTextMode mode=wxPDF_SHAPEDTEXTMODE_STRETCHTOFIT) |
Prints a text string along a path defined by a shape. | |
virtual wxPdfLayer * | AddLayer (const wxString &layerName) |
Add a layer. | |
virtual wxPdfLayer * | AddLayerTitle (const wxString &layerTitle) |
Add a title layer. | |
virtual wxPdfLayerMembership * | AddLayerMembership () |
Add a layer membership container. | |
virtual void | LockLayer (wxPdfLayer *layer) |
Lock a layer. | |
virtual void | AddLayerRadioGroup (const wxPdfLayerGroup &radioGroup) |
Add a radio group of layers. | |
virtual void | EnterLayer (wxPdfLayer *layer) |
Enter a layer. | |
virtual void | EnterLayer (wxPdfLayerMembership *layer) |
virtual void | LeaveLayer () |
Leave a layer. | |
void | SetMessageTranslateMode (bool translate) |
Set message translation mode. | |
bool | GetMessageTranslateMode () |
Get message translation mode. | |
Protected Member Functions | |
virtual void | Initialize (int orientation) |
Initialize. | |
virtual void | SaveGraphicState () |
Save graphic state. | |
virtual void | RestoreGraphicState () |
Restore graphic state. | |
virtual void | ClearGraphicState () |
Clear graphic state. | |
virtual bool | SelectFont (const wxString &family, const wxString &style=wxEmptyString, double size=0, bool setFont=true) |
Select font. | |
virtual bool | SelectFont (const wxString &family, int style, double size=0, bool setFont=true) |
Select font. | |
virtual bool | SelectFont (const wxFont &font, bool setFont=true) |
Select font based on wxFont object. | |
virtual bool | SelectFont (const wxPdfFont &font, int style, double size=0, bool setFont=true) |
Select font based on wxFont object. | |
virtual void | ForceCurrentFont () |
Force selecting the current font. | |
virtual wxString | ApplyVisualOrdering (const wxString &txt) |
Apply visual ordering. | |
virtual double | DoGetStringWidth (const wxString &s) |
Returns the length of a string in user unit. | |
virtual void | DoCell (double w, double h=0., const wxString &txt=wxEmptyString, int border=wxPDF_BORDER_NONE, int ln=0, int align=wxPDF_ALIGN_LEFT, int fill=0, const wxPdfLink &link=wxPdfLink(-1)) |
Prints a cell (rectangular area) with optional borders, background colour and character string. | |
virtual void | BeginPage (int orientation, wxSize pageSize) |
Start document. | |
virtual void | EndPage () |
End of page contents. | |
virtual void | EndDoc () |
End dociment. | |
virtual void | PutHeader () |
Add header. | |
virtual void | PutPages () |
Add pages. | |
virtual void | ReplaceNbPagesAlias () |
Replace page number aliases. | |
virtual void | PutResources () |
Add resources. | |
virtual void | PutBookmarks () |
Add bookmarks. | |
virtual void | PutExtGStates () |
Add extended graphics states. | |
virtual void | PutShaders () |
Add shaders. | |
virtual void | PutFonts () |
Adds fonts. | |
virtual void | PutImages () |
Add images. | |
virtual void | PutTemplates () |
Add templates. | |
virtual void | PutImportedObjects () |
Add imported objects. | |
virtual void | WriteObjectValue (wxPdfObject *value, bool newline=true) |
virtual void | PutSpotColours () |
Add spot colours. | |
virtual void | PutPatterns () |
Add patterns. | |
virtual void | PutLayers () |
Add layers. | |
void | PutOCProperties () |
Add optional content properties. | |
void | PutOCGOrder (wxPdfLayer *layer) |
Add optional content order. | |
void | PutASEvent (const wxString &situation, const wxString &category, bool &first) |
Add automatic state event. | |
virtual void | PutJavaScript () |
Add Javascript (document level) | |
virtual void | PutResourceDict () |
Add resource dictionary. | |
virtual void | PutEncryption () |
Add encryption info. | |
virtual void | PutFormFields () |
Add form fields. | |
virtual void | PutInfo () |
Add info. | |
virtual void | PutCatalog () |
Addcatalog. | |
virtual void | PutXObjectDict () |
Add object dictionary. | |
virtual void | PutTrailer () |
Add trailer. | |
size_t | CalculateStreamLength (size_t len) |
Calculate stream size. | |
size_t | CalculateStreamOffset () |
Calculate stream offset. | |
int | GetNewObjId () |
Get new object id. | |
void | NewObj (int objId=0) |
Begin a new object. | |
wxString | DoDecoration (double x, double y, const wxString &txt) |
Decorate text. | |
void | ShowText (const wxString &txt) |
Show text string, with kerning if requested. | |
void | ShowGlyph (wxUint32 glyph) |
Show a single glyph. | |
void | TextEscape (const wxString &s, bool newline=true) |
Format a text string. | |
void | PutStream (wxMemoryOutputStream &s) |
Add byte stream. | |
void | OutTextstring (const wxString &s, bool newline=true) |
Add a text string to the document. | |
void | OutRawTextstring (const wxString &s, bool newline=true) |
Add a raw text string to the document (without charset conversion) | |
void | OutHexTextstring (const wxString &s, bool newline=true) |
Add a hex text string to the document (without charset conversion) | |
void | OutAsciiTextstring (const wxString &s, bool newline=true) |
Add an ASCII text string to the document. | |
void | OutEscape (const char *s, size_t len) |
Add \ before \, ( and ) | |
void | OutAscii (const wxString &s, bool newline=true) |
Add ASCII string. | |
void | Out (const char *s, bool newline=true) |
Add character string. | |
void | Out (const char *s, size_t len, bool newline=true) |
Add len characters. | |
void | OutPoint (double x, double y) |
Sets a draw point. | |
void | OutPointRelative (double dx, double dy) |
Sets a draw point relative to current position. | |
void | OutLine (double x, double y) |
Draws a line from last draw point. | |
void | OutLineRelative (double dx, double dy) |
Draws a line relative from last draw point. | |
void | OutCurve (double x1, double y1, double x2, double y2, double x3, double y3) |
Draws a Bézier curve from last draw point. | |
void | Transform (double tm[6]) |
Perform transformation. | |
void | AddFormField (wxPdfAnnotationWidget *field, bool setFormField=true) |
Adds a form field to the document. | |
void | OutIndirectObject (wxPdfIndirectObject *object) |
Add an indirect object to the document. | |
void | OutImage (wxPdfImage *currentImage, double x, double y, double w, double h, const wxPdfLink &link) |
Add an image object to the document. | |
void | WriteXml (wxXmlNode *node) |
Write XML using XML node. | |
void | PrepareXmlCell (wxXmlNode *node, wxPdfCellContext &context) |
Prepare an XML cell for output. | |
void | WriteXmlCell (wxXmlNode *node, wxPdfCellContext &context) |
Output a prepared XML cell. | |
void | DoXmlAlign (wxPdfCellContext &context) |
Take alignment of an XML cell into account. | |
void | PrepareXmlTable (wxXmlNode *node, wxPdfCellContext &context) |
Prepare an XML table for output. | |
void | WriteXmlTable (wxPdfCellContext &context) |
Output a prepared XML table. | |
void | SetScaleFactor (const wxString &unit) |
Set internal scale factor. | |
wxSize | CalculatePageSize (wxPaperSize format) |
wxSize | CalculatePageSize (double pageWidth, double pageHeight) |
virtual void | AddPage (int orientation, wxSize pageSize) |
void | LoadZapfDingBats () |
Friends | |
class | wxPdfImage |
class | wxPdfTable |
Class representing a PDF document.
wxPdfDocument::wxPdfDocument | ( | int | orientation = wxPORTRAIT , |
const wxString & | unit = wxString(wxT("mm")) , |
||
wxPaperSize | format = wxPAPER_A4 |
||
) |
Constructor.
orientation | Defines the default page orientation. Possible values are:
|
unit | Defines the user units. Possible values are:
|
format | Defines the page format. All known wxWidgets paper types are allowed. (Default: wxPAPER_A4) |
wxPdfDocument::wxPdfDocument | ( | int | orientation, |
double | pageWidth, | ||
double | pageHeight, | ||
const wxString & | unit = wxString(wxT("mm")) |
||
) |
virtual wxPdfDocument::~wxPdfDocument | ( | ) | [virtual] |
virtual bool wxPdfDocument::AcceptPageBreak | ( | ) | [virtual] |
Whenever a page break condition is met,.
Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by SetAutoPageBreak()
This method is called automatically and should not be called directly by the application.
virtual bool wxPdfDocument::AddFont | ( | const wxString & | family, |
const wxString & | style = wxEmptyString , |
||
const wxString & | file = wxEmptyString |
||
) | [virtual] |
Imports a TrueType, TrueTypeUnicode or Type1 font and makes it available.
It is necessary to generate a font definition file first with the makefont utility. The definition file (and the font file itself when embedding) must be present either in the subdirectory 'fonts' of the current working directory or in the one indicated by WXPDF_FONTPATH if this environment variable is defined.
family | Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font. |
style | Font style. Possible values are (case insensitive):
|
file | The font definition file. By default, the name is built from the family and style, in lower case with no space. |
virtual bool wxPdfDocument::AddFontCJK | ( | const wxString & | family | ) | [virtual] |
Imports a CJK (Chinese, Japanese or Korean) font and makes it available.
It is necessary to generate a font definition file first with the makefont utility. The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by WXPDF_FONTPATH if the constant is defined.
family | Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font. |
All font styles (regular, bold, italic and bold-italic) are made available The font definition file name is built from the family in lower case with no space. There are several predefined font definition files available:
These fonts require that the Adobe CJK font support is installed
void wxPdfDocument::AddFormField | ( | wxPdfAnnotationWidget * | field, |
bool | setFormField = true |
||
) | [protected] |
Adds a form field to the document.
virtual wxPdfLayer* wxPdfDocument::AddLayer | ( | const wxString & | layerName | ) | [virtual] |
Add a layer.
An optional content group represents a collection of graphics that can be made visible or invisible dynamically by users of viewer applications. In wxPdfDocument they are referenced as layers.
layerName | the name of the layer |
virtual wxPdfLayerMembership* wxPdfDocument::AddLayerMembership | ( | ) | [virtual] |
Add a layer membership container.
Content typically belongs to a single optional content group, and is visible when the group is ON and invisible when it is OFF. To express more complex visibility policies, content should not declare itself to belong to an optional content group directly, but rather to an optional content membership container.
virtual void wxPdfDocument::AddLayerRadioGroup | ( | const wxPdfLayerGroup & | radioGroup | ) | [virtual] |
Add a radio group of layers.
Use this method to set a collection of optional content groups whose states are intended to follow a "radio button" paradigm. That is, the state of at most one optional content group in the array should be ON at a time: if one group is turned ON, all others must be turned OFF.
radioGroup | the radio group |
virtual wxPdfLayer* wxPdfDocument::AddLayerTitle | ( | const wxString & | layerTitle | ) | [virtual] |
Add a title layer.
Creates a title layer. A title layer is not really a layer but a collection of layers under the same title heading.
layerTitle | the title text |
virtual int wxPdfDocument::AddLink | ( | ) | [virtual] |
virtual void wxPdfDocument::AddPage | ( | int | orientation, |
double | pageWidth, | ||
double | pageHeight | ||
) | [virtual] |
virtual void wxPdfDocument::AddPage | ( | int | orientation, |
wxSize | pageSize | ||
) | [protected, virtual] |
virtual void wxPdfDocument::AddPage | ( | int | orientation = -1 | ) | [virtual] |
Adds a new page to the document.
If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header. The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colours and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
orientation | Page orientation. Possible values are:
|
virtual void wxPdfDocument::AddPage | ( | int | orientation, |
wxPaperSize | format | ||
) | [virtual] |
virtual bool wxPdfDocument::AddPattern | ( | const wxString & | patternName, |
const wxImage & | image, | ||
double | width, | ||
double | height | ||
) | [virtual] |
Add an image pattern.
Add a pattern which can be reference in draw or fill pattern methods
patternName | the name of the pattern (case sensitive) |
image | the image to use for the pattern |
width | the display width |
height | the display height |
virtual void wxPdfDocument::AddSpotColour | ( | const wxString & | name, |
double | cyan, | ||
double | magenta, | ||
double | yellow, | ||
double | black | ||
) | [virtual] |
Add spot colour.
Add a spot colour which can be referenced in colour setting methods
name | the name of the spot colour (case sensitive) |
cyan | indicates the cyan level. Value between 0 and 100 |
magenta | indicates the magenta level. Value between 0 and 100 |
yellow | indicates the yellow level. Value between 0 and 100 |
black | indicates the black level. Value between 0 and 100 |
virtual void wxPdfDocument::AliasNbPages | ( | const wxString & | alias = wxString(wxT("{nb}")) | ) | [virtual] |
virtual void wxPdfDocument::Annotate | ( | double | x, |
double | y, | ||
const wxString & | text | ||
) | [virtual] |
Adds a text annotation.
x | abscissa of the annotation symbol |
y | ordinate of the annotation symbol |
text | annotation text |
virtual void wxPdfDocument::AppendJavascript | ( | const wxString & | javascript | ) | [virtual] |
Appends Javascript.
Allows to append Javascript code to a Javascript object at the document level.
javascript | Javascript code to be appended |
virtual wxString wxPdfDocument::ApplyVisualOrdering | ( | const wxString & | txt | ) | [protected, virtual] |
Apply visual ordering.
virtual void wxPdfDocument::Arrow | ( | double | x1, |
double | y1, | ||
double | x2, | ||
double | y2, | ||
double | linewidth, | ||
double | height, | ||
double | width | ||
) | [virtual] |
Draws an arrow line between two points.
x1 | Abscissa of first point |
y1 | Ordinate of first point |
x2 | Abscissa of second point |
y2 | Ordinate of second point |
linewidth | line width |
height | height of the arrow head |
width | width of the arrow head |
virtual int wxPdfDocument::AxialGradient | ( | const wxPdfColour & | col1, |
const wxPdfColour & | col2, | ||
double | x1 = 0 , |
||
double | y1 = 0 , |
||
double | x2 = 1 , |
||
double | y2 = 0 , |
||
double | intexp = 1 |
||
) | [virtual] |
Defines a axial gradient shading.
col1 | first colour (RGB or CMYK). |
col2 | second colour (RGB or CMYK). |
x1 | start point of gradient vector, default: 0 (range 0 .. 1) |
y1 | start point of gradient vector, default: 0 (range 0 .. 1) |
x2 | end point of gradient vector, default: 1 (range 0 .. 1) |
y2 | end point of gradient vector, default: 0 (range 0 .. 1) |
intexp | interpolation exponent, default: 1 |
virtual void wxPdfDocument::BeginPage | ( | int | orientation, |
wxSize | pageSize | ||
) | [protected, virtual] |
Start document.
virtual int wxPdfDocument::BeginTemplate | ( | double | x = 0 , |
double | y = 0 , |
||
double | width = 0 , |
||
double | height = 0 |
||
) | [virtual] |
Starts a new Template.
Starts a new template, optionally with own dimensions. The margins have to adapted to the new template size. For writing outside the template, for example to build a clipped template, the margins and "cursor" position have to be set manually after the call to BeginTemplate().
If no dimensions are given, the template uses the current page size. The method returns the ID of the current template. The ID is used to reference a template in the UseTemplate() method. Warning: A template once created is embedded in the resulting PDF document at all events, even if it is not used.
x | The x-coordinate given in user units |
y | The y-coordinate given in user units |
width | The width given in user units |
height | The height given in user units |
Attention: Calls to BeginTemplate can not be nested!
virtual void wxPdfDocument::BezierSpline | ( | const wxPdfArrayDouble & | x, |
const wxPdfArrayDouble & | y, | ||
int | style | ||
) | [virtual] |
Draws a Bezier spline through a list of points.
x | Array with abscissa values |
y | Array with ordinate values |
style,: | Style of the spline (draw and/or fill) |
virtual void wxPdfDocument::Bookmark | ( | const wxString & | txt, |
int | level = 0 , |
||
double | y = 0 |
||
) | [virtual] |
Adds a bookmark to the document outline.
txt,: | the bookmark title. |
level,: | the bookmark level (0 is top level, 1 is just below, and so on). |
y,: | the y position of the bookmark destination in the current page. -1 means the current position. Default value: 0. |
wxSize wxPdfDocument::CalculatePageSize | ( | wxPaperSize | format | ) | [protected] |
wxSize wxPdfDocument::CalculatePageSize | ( | double | pageWidth, |
double | pageHeight | ||
) | [protected] |
size_t wxPdfDocument::CalculateStreamLength | ( | size_t | len | ) | [protected] |
Calculate stream size.
size_t wxPdfDocument::CalculateStreamOffset | ( | ) | [protected] |
Calculate stream offset.
virtual void wxPdfDocument::Cell | ( | double | w, |
double | h = 0. , |
||
const wxString & | txt = wxEmptyString , |
||
int | border = wxPDF_BORDER_NONE , |
||
int | ln = 0 , |
||
int | align = wxPDF_ALIGN_LEFT , |
||
int | fill = 0 , |
||
const wxPdfLink & | link = wxPdfLink(-1) |
||
) | [virtual] |
Prints a cell (rectangular area) with optional borders, background colour and character string.
The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text. If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
w | Cell width. If 0, the cell extends up to the right margin. |
h | Cell height. Default value: 0. |
txt | String to print. Default value: empty string. |
border | Indicates if borders must be drawn around the cell. The value can be
|
ln | Indicates where the current position should go after the call. Possible values are:
|
align | Allows to center or align the text. Possible values are:
|
fill | Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. |
link | URL or identifier returned by AddLink(). |
virtual void wxPdfDocument::CheckBox | ( | const wxString & | name, |
double | width, | ||
bool | checked = false |
||
) | [virtual] |
Adds a check box field at the current position.
Adds a check box to the list of form fields at the current position
name | field name of the check box |
width | width of the check box |
checked | default value of the check box |
virtual void wxPdfDocument::CheckBox | ( | const wxString & | name, |
double | x, | ||
double | y, | ||
double | width, | ||
bool | checked = false |
||
) | [virtual] |
Adds a check box field.
Adds a check box to the list of form fields
name | field name of the check box |
x | abscissa of the check box position |
y | ordinate of the check box position |
width | width of the check box |
checked | default value of the check box |
virtual void wxPdfDocument::Circle | ( | double | x0, |
double | y0, | ||
double | r, | ||
double | astart = 0 , |
||
double | afinish = 360 , |
||
int | style = wxPDF_STYLE_DRAW , |
||
int | nSeg = 8 |
||
) | [virtual] |
Draws a circle.
x0,: | Abscissa of Center point |
y0,: | Ordinate of Center point |
r,: | Radius |
astart,: | Start angle |
afinish,: | Finish angle |
style,: | Style of rectangle (draw and/or fill) |
nSeg,: | Circle is made up of nSeg Bezier curves |
virtual void wxPdfDocument::ClearGraphicState | ( | ) | [protected, virtual] |
Clear graphic state.
virtual void wxPdfDocument::ClippedCell | ( | double | w, |
double | h = 0. , |
||
const wxString & | txt = wxEmptyString , |
||
int | border = wxPDF_BORDER_NONE , |
||
int | ln = 0 , |
||
int | align = wxPDF_ALIGN_LEFT , |
||
int | fill = 0 , |
||
const wxPdfLink & | link = wxPdfLink(-1) |
||
) | [virtual] |
Prints a cell clipped to a rectangular area.
The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text. If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
w | Cell width. |
h | Cell height. |
txt | String to print. Default value: empty string. |
border | Indicates if borders must be drawn around the cell. The value can be
|
ln | Indicates where the current position should go after the call. Possible values are:
|
align | Allows to center or align the text. Possible values are:
|
fill | Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. |
link | URL or identifier returned by AddLink(). |
virtual void wxPdfDocument::ClippingEllipse | ( | double | x, |
double | y, | ||
double | rx, | ||
double | ry = 0 , |
||
bool | outline = false |
||
) | [virtual] |
Define ellipse as clipping area.
A clipping area restricts the display and prevents any elements from showing outside of it.
x | Abscissa of the Center point |
y | Ordinate of the Center point |
rx,: | Horizontal radius |
ry,: | Vertical radius (if ry = 0, draws a circle) |
outline | Draw the outline or not. (Default false) |
virtual void wxPdfDocument::ClippingPath | ( | ) | [virtual] |
Start defining a clipping path.
A clipping area restricts the display and prevents any elements from showing outside of it. The clipping path may consist of one or more subpaths.
virtual void wxPdfDocument::ClippingPath | ( | const wxPdfShape & | shape, |
int | style = wxPDF_STYLE_NOOP |
||
) | [virtual] |
Define clipping area using a shape.
A clipping area restricts the display and prevents any elements from showing outside of it.
shape | shape defining the clipping path |
style | Style of rendering. Possible values are:
|
virtual void wxPdfDocument::ClippingPolygon | ( | const wxPdfArrayDouble & | x, |
const wxPdfArrayDouble & | y, | ||
bool | outline = false |
||
) | [virtual] |
Define polygon as clipping area.
A clipping area restricts the display and prevents any elements from showing outside of it.
x | Array with abscissa values |
y | Array with ordinate values |
outline | Draw the outline or not. (Default false) |
virtual void wxPdfDocument::ClippingRect | ( | double | x, |
double | y, | ||
double | w, | ||
double | h, | ||
bool | outline = false |
||
) | [virtual] |
Define rectangle as clipping area.
A clipping area restricts the display and prevents any elements from showing outside of it.
x | Abscissa of the upper-left corner |
y | Ordinate of the upper-left corner |
w | Width of the rectangle |
h | Height of the rectangle |
outline | Draw the outline or not. |
virtual void wxPdfDocument::ClippingText | ( | double | x, |
double | y, | ||
const wxString & | txt, | ||
bool | outline = false |
||
) | [virtual] |
Define text as clipping area.
A clipping area restricts the display and prevents any elements from showing outside of it.
x | Abscissa of the origin |
y | Ordinate of the origin |
txt | String to print |
outline | Draw the outline or not. |
virtual void wxPdfDocument::Close | ( | ) | [virtual] |
Terminates the PDF document.
It is not necessary to call this method explicitly because SaveAsFile() does it automatically. If the document contains no page, AddPage() is called to prevent from getting an invalid document.
virtual const wxMemoryOutputStream& wxPdfDocument::CloseAndGetBuffer | ( | ) | [virtual] |
virtual void wxPdfDocument::ClosedBezierSpline | ( | const wxPdfArrayDouble & | x, |
const wxPdfArrayDouble & | y, | ||
int | style | ||
) | [virtual] |
Draws a closed Bezier spline through a list of points.
x | Array with abscissa values |
y | Array with ordinate values |
style,: | Style of the spline (draw and/or fill) |
virtual void wxPdfDocument::ClosePath | ( | int | style = wxPDF_STYLE_NOOP | ) | [virtual] |
Close the clipping path.
A clipping area restricts the display and prevents any elements from showing outside of it.
style | Style of rendering. Possible values are:
|
virtual void wxPdfDocument::ComboBox | ( | const wxString & | name, |
double | width, | ||
double | height, | ||
const wxArrayString & | values | ||
) | [virtual] |
Adds a combo box field at the current position.
Adds a combo box to the list of form fields at the current position
name | field name of the combo box |
width | width of the combo box |
height | height of the combo box |
values | array of option values of the combo box |
virtual void wxPdfDocument::ComboBox | ( | const wxString & | name, |
double | x, | ||
double | y, | ||
double | width, | ||
double | height, | ||
const wxArrayString & | values | ||
) | [virtual] |
Adds a combo box field.
Adds a combo box to the list of form fields
name | field name of the combo box |
x | abscissa of the combo box position |
y | ordinate of the combo box position |
width | width of the combo box |
height | height of the combo box |
values | array of option values of the combo box |
virtual int wxPdfDocument::CoonsPatchGradient | ( | const wxPdfCoonsPatchMesh & | mesh, |
double | minCoord = 0 , |
||
double | maxCoord = 1 |
||
) | [virtual] |
Defines a coons patch mesh gradient shading.
mesh | coons patch mesh to be used for the gradient |
minCoord | minimal coordinate of the mesh |
maxCoord | maximal coordinate of the mesh |
virtual void wxPdfDocument::Curve | ( | double | x0, |
double | y0, | ||
double | x1, | ||
double | y1, | ||
double | x2, | ||
double | y2, | ||
double | x3, | ||
double | y3, | ||
int | style = wxPDF_STYLE_DRAW |
||
) | [virtual] |
Draws a Bezier curve.
A Bezier curve is tangent to the line between the control points at either end of the curve.
x0,: | Abscissa of start point |
y0,: | Ordinate of start point |
x1,: | Abscissa of control point 1 |
y1,: | Ordinate of control point 1 |
x2,: | Abscissa of control point 2 |
y2,: | Ordinate of control point 2 |
x3,: | Abscissa of end point |
y3,: | Ordinate of end point |
style,: | Style of rectangle (draw and/or fill) |
virtual void wxPdfDocument::CurveTo | ( | double | x1, |
double | y1, | ||
double | x2, | ||
double | y2, | ||
double | x3, | ||
double | y3 | ||
) | [virtual] |
Append a cubic Bezier curve to the current (sub)path.
Append a cubic Bezier curve to the current path. The curve extends from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bézier control points. The new current point is (x3, y3).
x1,: | Abscissa of control point 1 |
y1,: | Ordinate of control point 1 |
x2,: | Abscissa of control point 2 |
y2,: | Ordinate of control point 2 |
x3,: | Abscissa of end point |
y3,: | Ordinate of end point |
virtual void wxPdfDocument::DoCell | ( | double | w, |
double | h = 0. , |
||
const wxString & | txt = wxEmptyString , |
||
int | border = wxPDF_BORDER_NONE , |
||
int | ln = 0 , |
||
int | align = wxPDF_ALIGN_LEFT , |
||
int | fill = 0 , |
||
const wxPdfLink & | link = wxPdfLink(-1) |
||
) | [protected, virtual] |
Prints a cell (rectangular area) with optional borders, background colour and character string.
wxString wxPdfDocument::DoDecoration | ( | double | x, |
double | y, | ||
const wxString & | txt | ||
) | [protected] |
Decorate text.
virtual double wxPdfDocument::DoGetStringWidth | ( | const wxString & | s | ) | [protected, virtual] |
Returns the length of a string in user unit.
A font must be selected.
s | The string whose length is to be computed |
void wxPdfDocument::DoXmlAlign | ( | wxPdfCellContext & | context | ) | [protected] |
Take alignment of an XML cell into account.
virtual void wxPdfDocument::Ellipse | ( | double | x0, |
double | y0, | ||
double | rx, | ||
double | ry = 0 , |
||
double | angle = 0 , |
||
double | astart = 0 , |
||
double | afinish = 360 , |
||
int | style = wxPDF_STYLE_DRAW , |
||
int | nSeg = 8 , |
||
bool | doSector = false |
||
) | [virtual] |
Draws an ellipse.
x0,: | Abscissa of Center point |
y0,: | Ordinate of Center point |
rx,: | Horizontal radius |
ry,: | Vertical radius (if ry = 0, draws a circle) |
angle,: | Orientation angle (anti-clockwise) |
astart,: | Start angle |
afinish,: | Finish angle |
style,: | Style of rectangle (draw and/or fill) |
nSeg,: | Ellipse is made up of nSeg Bezier curves |
doSector,: | connect end points of elliptic arc with center point |
virtual void wxPdfDocument::EndDoc | ( | ) | [protected, virtual] |
End dociment.
virtual void wxPdfDocument::EndPage | ( | ) | [protected, virtual] |
End of page contents.
virtual void wxPdfDocument::EndPath | ( | int | style = wxPDF_STYLE_DRAW | ) | [virtual] |
End a graphics path.
style | Style of rendering. Possible values are:
|
virtual int wxPdfDocument::EndTemplate | ( | ) | [virtual] |
Terminates a template.
Terminates the creation of a template and reset initiated variables on beginTemplate.
virtual void wxPdfDocument::EnterLayer | ( | wxPdfLayer * | layer | ) | [virtual] |
Enter a layer.
Begins a graphic block whose visibility is controlled by the layer
. Blocks can be nested. Each block must be terminated by LeaveLayer().
Note that nested layers only require a single call to this method and a single call to LeaveLayer(); all the nesting control is built in.
layer | the layer |
virtual void wxPdfDocument::EnterLayer | ( | wxPdfLayerMembership * | layer | ) | [virtual] |
virtual void wxPdfDocument::Footer | ( | ) | [virtual] |
This method is used to render the page footer.
It is automatically called by AddPage() and Close() and should not be called directly by the application. The implementation in wxPdfDocument is empty, so you have to subclass it and override the method if you want a specific processing.
virtual void wxPdfDocument::ForceCurrentFont | ( | ) | [protected, virtual] |
Force selecting the current font.
virtual double wxPdfDocument::GetBreakMargin | ( | ) | [virtual] |
Returns the page break margin.
virtual double wxPdfDocument::GetCellMargin | ( | ) | [virtual] |
Returns the cell margin.
virtual wxPdfFont wxPdfDocument::GetCurrentFont | ( | ) | const [virtual] |
virtual const wxPdfColour wxPdfDocument::GetDrawColour | ( | ) | [virtual] |
Gets the colour used for all drawing operations.
virtual const wxPdfColour wxPdfDocument::GetFillColour | ( | ) | [virtual] |
Gets the colour used for all filling operations.
virtual int wxPdfDocument::GetFillingRule | ( | ) | [virtual] |
Get the current filling rule.
virtual const wxPdfFontDescription& wxPdfDocument::GetFontDescription | ( | ) | const [virtual] |
Returns the current font description instance.
virtual const wxString wxPdfDocument::GetFontFamily | ( | ) | [virtual] |
Gets the font family of the current font.
virtual double wxPdfDocument::GetFontSize | ( | ) | const [virtual] |
Gets the size of the current font.
virtual const wxString wxPdfDocument::GetFontStyle | ( | ) | const [virtual] |
Gets the style of the current font.
virtual int wxPdfDocument::GetFontStyles | ( | ) | const [virtual] |
virtual bool wxPdfDocument::GetFontSubsetting | ( | ) | const [inline, virtual] |
Returns the font embedding mode.
virtual double wxPdfDocument::GetImageScale | ( | ) | [virtual] |
Returns the image scale.
virtual double wxPdfDocument::GetLeftMargin | ( | ) | [virtual] |
Returns the left margin.
virtual double wxPdfDocument::GetLineHeight | ( | ) | [virtual] |
Returns the height of a text line.
virtual const wxPdfLineStyle& wxPdfDocument::GetLineStyle | ( | ) | [virtual] |
Get current line style.
virtual double wxPdfDocument::GetLineWidth | ( | ) | [virtual] |
Gets the current line width.
bool wxPdfDocument::GetMessageTranslateMode | ( | ) | [inline] |
Get message translation mode.
Gets the message translation mode which controls the handling of msg tags in XML output
int wxPdfDocument::GetNewObjId | ( | ) | [protected] |
Get new object id.
virtual double wxPdfDocument::GetPageHeight | ( | ) | [virtual] |
Returns the page height in units.
virtual double wxPdfDocument::GetPageWidth | ( | ) | [virtual] |
Returns the page width in units.
virtual const wxPdfColour wxPdfDocument::GetPatternColour | ( | const wxString & | patternName | ) | [virtual] |
Gets the named pattern as a colour.
patternName | the name of the pattern |
virtual double wxPdfDocument::GetRightMargin | ( | ) | [virtual] |
Returns the right margin.
virtual double wxPdfDocument::GetScaleFactor | ( | ) | [virtual] |
Returns the scale factor (number of points in user unit).
virtual bool wxPdfDocument::GetSourceInfo | ( | wxPdfInfo & | info | ) | [virtual] |
Gets the document information dictionary of the current external PDF document.
Gets the values of the Info dictionary of the current external document, if available.
info | the info dictionary object receiving the document information |
virtual double wxPdfDocument::GetStringWidth | ( | const wxString & | s | ) | [virtual] |
Returns the length of a string in user unit.
A font must be selected.
s | The string whose length is to be computed |
virtual void wxPdfDocument::GetTemplateBBox | ( | int | templateId, |
double & | x, | ||
double & | y, | ||
double & | width, | ||
double & | height | ||
) | [virtual] |
Gets the bounding box of a template.
Especially for pages imported from an external PDF document the size of the bounding box might be of interest. The values returned correspond to the coordinates of the lower left corner and the width and height of the template.
templateId | A valid template ID |
x | The x coordinate of the lower left corner |
y | The y coordinate of the lower left corner |
width | The width of the template |
height | The height of the template |
virtual void wxPdfDocument::GetTemplateSize | ( | int | templateId, |
double & | width, | ||
double & | height | ||
) | [virtual] |
Get the calculated size of a template.
Retrieves the size of a template.
templateId | A valid template ID |
width | The width of the template |
height | The height of the template |
Attention: The width and/or height parameters have to be set to a value <= 0 prior to calling this method, otherwise they will not be calculated. If one dimension, i.e. width, is passed with a value > 0, the other one, i.e. height, is calculated accordingly.
virtual const wxPdfColour wxPdfDocument::GetTextColour | ( | ) | [virtual] |
Gets the colour used for text output.
virtual wxPdfTextRenderMode wxPdfDocument::GetTextRenderMode | ( | ) | const [virtual] |
Returns the text render mode.
virtual double wxPdfDocument::GetTopMargin | ( | ) | [virtual] |
Returns the top margin.
virtual double wxPdfDocument::GetX | ( | ) | [virtual] |
virtual double wxPdfDocument::GetY | ( | ) | [virtual] |
virtual void wxPdfDocument::Header | ( | ) | [virtual] |
This method is used to render the page header.
It is automatically called by AddPage() and should not be called directly by the application. The implementation in wxPdfDocument is empty, so you have to subclass it and override the method if you want a specific processing.
virtual bool wxPdfDocument::Image | ( | const wxString & | file, |
double | x, | ||
double | y, | ||
double | w = 0 , |
||
double | h = 0 , |
||
const wxString & | mimeType = wxEmptyString , |
||
const wxPdfLink & | link = wxPdfLink(-1) , |
||
int | maskImage = 0 |
||
) | [virtual] |
Puts an image in the page.
The upper-left corner must be given. The dimensions can be specified in different ways:
Supported formats are JPEG, PNG, GIF and WMF. For JPEG, all flavors are allowed:
For PNG, the following flavors are allowed:
but the following options are not supported:
If a transparent colour is defined, it will be taken into account (but will be only interpreted by Acrobat 4 and above).
For GIF, all flavors the wsWidgets GIF decoder is able to handle are supported
For WMF: WMF files contain vector data described in terms of Windows Graphics Device Interface (GDI) commands. There are approximately 80 different GDI commands allowed for in the WMF standard. This method interprets only a small subset of these, but is sufficient to display most WMF images. Please feel free to add further functionality.
The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.
file | Name of the file containing the image. |
x | Abscissa of the upper-left corner. |
y | Ordinate of the upper-left corner. |
w | Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
h | Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
mimeType | Image format. Possible values are: image/jpeg, image/png, image/gif, image/wmf. If not specified, the type is inferred from the file extension. |
link | URL or identifier returned by AddLink(). |
maskImage | Id of an image mask created previously by ImageMask(). |
virtual bool wxPdfDocument::Image | ( | const wxString & | name, |
wxInputStream & | stream, | ||
const wxString & | mimeType, | ||
double | x, | ||
double | y, | ||
double | w = 0 , |
||
double | h = 0 , |
||
const wxPdfLink & | link = wxPdfLink(-1) , |
||
int | maskImage = 0 |
||
) | [virtual] |
Puts an image in the page The image is given by an wxInputStream-Object containing the raw image data.
name | Name of the image to be used as an identifier for this image object. |
stream | wxInputStream object containing the raw image data |
mimeType | Image format. Possible values are: image/jpeg, image/png, image/gif, image/wmf. |
x | Abscissa of the upper-left corner. |
y | Ordinate of the upper-left corner. |
w | Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
h | Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
link | URL or identifier returned by AddLink(). |
maskImage | Id of an image mask created previously by ImageMask(). |
virtual bool wxPdfDocument::Image | ( | const wxString & | name, |
const wxImage & | image, | ||
double | x, | ||
double | y, | ||
double | w = 0 , |
||
double | h = 0 , |
||
const wxPdfLink & | link = wxPdfLink(-1) , |
||
int | maskImage = 0 |
||
) | [virtual] |
Puts an image in the page The image is given by an wxImage-Object
name | Name of the image to be used as an identifier for this image object. |
image | wxImage object which will be embedded as PNG |
x | Abscissa of the upper-left corner. |
y | Ordinate of the upper-left corner. |
w | Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
h | Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
link | URL or identifier returned by AddLink(). |
maskImage | Id of an image mask created previously by ImageMask(). |
virtual int wxPdfDocument::ImageMask | ( | const wxString & | name, |
const wxImage & | image | ||
) | [virtual] |
Prepares an image for use as an image mask The image is given by an wxImage-Object
name | Name of the image. |
image | wxImage object. |
virtual int wxPdfDocument::ImageMask | ( | const wxString & | file, |
const wxString & | mimeType = wxEmptyString |
||
) | [virtual] |
Prepares an image for use as an image mask The image is given as the name of the file conatining the image
file | Name of the file containing the image. |
mimeType | Image format. Possible values are: image/jpeg, image/png, image/gif, image/wmf. |
virtual int wxPdfDocument::ImageMask | ( | const wxString & | name, |
wxInputStream & | stream, | ||
const wxString & | mimeType | ||
) | [virtual] |
Prepares an image for use as an image mask The image is given by an wxInputStream-Object containing the raw image data.
name | Name of the image. |
stream | wxInputStream object containing the raw image data |
mimeType | Image format. Possible values are: image/jpeg, image/png, image/gif, image/wmf. |
virtual int wxPdfDocument::ImportPage | ( | unsigned int | pageno, |
wxPdfPageBox | pageBox = wxPDF_PAGEBOX_ARTBOX |
||
) | [virtual] |
Imports a page from an external PDF document.
Imports a page from the current external PDF document. As the bounding box of the template the ArtBox of the imported page is used. If the page does not have an explicit ArtBox, the CropBox will be used instead; if there is no explicit CropBox then the MediaBox will be used.
pageno | page number of the page to be imported |
pageBox | page box which should be used (default: ArtBox) |
virtual void wxPdfDocument::Initialize | ( | int | orientation | ) | [protected, virtual] |
Initialize.
virtual bool wxPdfDocument::IsInFooter | ( | ) | [virtual] |
Returns whether footer output is in progress.
virtual void wxPdfDocument::LeaveLayer | ( | ) | [virtual] |
Leave a layer.
Ends a layer controlled graphic block. It will end the most recent open block.
virtual void wxPdfDocument::Line | ( | double | x1, |
double | y1, | ||
double | x2, | ||
double | y2 | ||
) | [virtual] |
Draws a line between two points.
x1 | Abscissa of first point |
y1 | Ordinate of first point |
x2 | Abscissa of second point |
y2 | Ordinate of second point |
virtual int wxPdfDocument::LinearGradient | ( | const wxPdfColour & | col1, |
const wxPdfColour & | col2, | ||
wxPdfLinearGradientType | gradientType = wxPDF_LINEAR_GRADIENT_HORIZONTAL |
||
) | [virtual] |
Defines a linear gradient shading.
col1 | first colour (RGB or CMYK). |
col2 | second colour (RGB or CMYK). |
gradientType | Type of the gradient |
virtual int wxPdfDocument::LineCount | ( | double | w, |
const wxString & | txt | ||
) | [virtual] |
This method counts the number of lines a text would occupy in respect to a given maximal width.
w | Width of cells. If 0, they extend up to the right margin of the page. |
txt | String for which the number of lines is to be counted |
virtual void wxPdfDocument::LineTo | ( | double | x, |
double | y | ||
) | [virtual] |
Append a straight line segment to the current (sub)path.
Append a straight line segment from the current point to the point (x, y). The new current point is (x, y).
x | abscissa value |
y | ordinate value |
virtual void wxPdfDocument::Link | ( | double | x, |
double | y, | ||
double | w, | ||
double | h, | ||
const wxPdfLink & | link | ||
) | [virtual] |
Puts a link on a rectangular area of the page.
Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.
x | Abscissa of the upper-left corner of the rectangle |
y | Ordinate of the upper-left corner of the rectangle |
w | Width of the rectangle |
h | Height of the rectangle |
link | URL or identifier returned by AddLink() |
virtual void wxPdfDocument::Ln | ( | double | h = -1 | ) | [virtual] |
Performs a line break.
The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
h | The height of the break. By default, the value equals the height of the last printed cell. |
void wxPdfDocument::LoadZapfDingBats | ( | ) | [protected] |
virtual void wxPdfDocument::LockLayer | ( | wxPdfLayer * | layer | ) | [virtual] |
Lock a layer.
Use this method to lock an optional content group. The state of a locked group cannot be changed through the user interface of a viewer application. Producers can use this entry to prevent the visibility of content that depends on these groups from being changed by users.
layer | the layer that needs to be added to the array of locked OCGs |
virtual void wxPdfDocument::Marker | ( | double | x, |
double | y, | ||
wxPdfMarker | markerType, | ||
double | size | ||
) | [virtual] |
Draws a graphical marker symbol.
x | abscissa of the marker's center |
y | ordinate of the marker's center |
markerType | type of the marker |
size | size of the marker |
virtual int wxPdfDocument::MidAxialGradient | ( | const wxPdfColour & | col1, |
const wxPdfColour & | col2, | ||
double | x1 = 0 , |
||
double | y1 = 0 , |
||
double | x2 = 1 , |
||
double | y2 = 0 , |
||
double | midpoint = 0.5 , |
||
double | intexp = 1 |
||
) | [virtual] |
Defines a axial gradient shading.
col1 | first colour (RGB or CMYK). |
col2 | second colour (RGB or CMYK). |
x1 | start point of gradient vector, default: 0 (range 0 .. 1) |
y1 | start point of gradient vector, default: 0 (range 0 .. 1) |
x2 | end point of gradient vector, default: 1 (range 0 .. 1) |
y2 | end point of gradient vector, default: 0 (range 0 .. 1) |
midpoint | position of the mirror point, default: 0.5 (range 0 .. 1) |
intexp | interpolation exponent, default: 1 |
virtual void wxPdfDocument::MirrorH | ( | double | x = -1 | ) | [virtual] |
Performs a horizontal mirroring transformation.
Alias for scaling -100% in x-direction
x,: | abscissa of the axis of reflection |
virtual void wxPdfDocument::MirrorV | ( | double | y = -1 | ) | [virtual] |
Performs a vertical mirroring transformation.
Alias for scaling -100% in y-direction
y,: | abscissa of the axis of reflection |
virtual void wxPdfDocument::MoveTo | ( | double | x, |
double | y | ||
) | [virtual] |
Begin a new subpath.
Move to the starting point of a new (sub)path. The new current point is (x, y).
x | abscissa value |
y | ordinate value |
virtual int wxPdfDocument::MultiCell | ( | double | w, |
double | h, | ||
const wxString & | txt, | ||
int | border = 0 , |
||
int | align = wxPDF_ALIGN_JUSTIFY , |
||
int | fill = 0 , |
||
int | maxline = 0 |
||
) | [virtual] |
This method allows printing text with line breaks.
They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the
character). As many cells as necessary are output, one below the other. Text can be aligned, centered or justified. The cell block can be framed and the background painted.
w | Width of cells. If 0, they extend up to the right margin of the page. |
h | Height of cells. |
txt | String to print |
border | Indicates if borders must be drawn around the cell. The value can be
|
align | Allows to center or align the text. Possible values are:
|
fill | Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. |
maxline | Defines the maximum number of lines which should be printed. If maxline is 0 then the number of lines is not restricted. Default value: 0. |
void wxPdfDocument::NewObj | ( | int | objId = 0 | ) | [protected] |
Begin a new object.
virtual void wxPdfDocument::Open | ( | ) | [virtual] |
void wxPdfDocument::Out | ( | const char * | s, |
bool | newline = true |
||
) | [protected] |
Add character string.
void wxPdfDocument::Out | ( | const char * | s, |
size_t | len, | ||
bool | newline = true |
||
) | [protected] |
Add len characters.
void wxPdfDocument::OutAscii | ( | const wxString & | s, |
bool | newline = true |
||
) | [protected] |
Add ASCII string.
void wxPdfDocument::OutAsciiTextstring | ( | const wxString & | s, |
bool | newline = true |
||
) | [protected] |
Add an ASCII text string to the document.
void wxPdfDocument::OutCurve | ( | double | x1, |
double | y1, | ||
double | x2, | ||
double | y2, | ||
double | x3, | ||
double | y3 | ||
) | [protected] |
Draws a Bézier curve from last draw point.
void wxPdfDocument::OutEscape | ( | const char * | s, |
size_t | len | ||
) | [protected] |
Add \ before \, ( and )
void wxPdfDocument::OutHexTextstring | ( | const wxString & | s, |
bool | newline = true |
||
) | [protected] |
Add a hex text string to the document (without charset conversion)
void wxPdfDocument::OutImage | ( | wxPdfImage * | currentImage, |
double | x, | ||
double | y, | ||
double | w, | ||
double | h, | ||
const wxPdfLink & | link | ||
) | [protected] |
Add an image object to the document.
void wxPdfDocument::OutIndirectObject | ( | wxPdfIndirectObject * | object | ) | [protected] |
Add an indirect object to the document.
void wxPdfDocument::OutLine | ( | double | x, |
double | y | ||
) | [protected] |
Draws a line from last draw point.
void wxPdfDocument::OutLineRelative | ( | double | dx, |
double | dy | ||
) | [protected] |
Draws a line relative from last draw point.
void wxPdfDocument::OutPoint | ( | double | x, |
double | y | ||
) | [protected] |
Sets a draw point.
void wxPdfDocument::OutPointRelative | ( | double | dx, |
double | dy | ||
) | [protected] |
Sets a draw point relative to current position.
void wxPdfDocument::OutRawTextstring | ( | const wxString & | s, |
bool | newline = true |
||
) | [protected] |
Add a raw text string to the document (without charset conversion)
void wxPdfDocument::OutTextstring | ( | const wxString & | s, |
bool | newline = true |
||
) | [protected] |
Add a text string to the document.
virtual int wxPdfDocument::PageNo | ( | ) | [virtual] |
virtual void wxPdfDocument::Polygon | ( | const wxPdfArrayDouble & | x, |
const wxPdfArrayDouble & | y, | ||
int | style = wxPDF_STYLE_DRAW |
||
) | [virtual] |
Draws a polygon.
x | Array with abscissa values |
y | Array with ordinate values |
style,: | Style of polygon (draw and/or fill) |
void wxPdfDocument::PrepareXmlCell | ( | wxXmlNode * | node, |
wxPdfCellContext & | context | ||
) | [protected] |
Prepare an XML cell for output.
void wxPdfDocument::PrepareXmlTable | ( | wxXmlNode * | node, |
wxPdfCellContext & | context | ||
) | [protected] |
Prepare an XML table for output.
virtual void wxPdfDocument::PushButton | ( | const wxString & | name, |
double | width, | ||
double | height, | ||
const wxString & | caption, | ||
const wxString & | action | ||
) | [virtual] |
Adds a push button at the current position.
Adds a push button to the list of form fields at the current position
name | field name of the push button |
width | width of the push button |
height | height of the push button |
caption | caption of the push button |
action | associated Javascript action |
virtual void wxPdfDocument::PushButton | ( | const wxString & | name, |
double | x, | ||
double | y, | ||
double | width, | ||
double | height, | ||
const wxString & | caption, | ||
const wxString & | action | ||
) | [virtual] |
Adds a push button.
Adds a push button to the list of form fields
name | field name of the push button |
x | abscissa of the push button position |
y | ordinate of the push button position |
width | width of the push button |
height | height of the push button |
caption | caption of the push button |
action | associated Javascript action |
void wxPdfDocument::PutASEvent | ( | const wxString & | situation, |
const wxString & | category, | ||
bool & | first | ||
) | [protected] |
Add automatic state event.
virtual void wxPdfDocument::PutBookmarks | ( | ) | [protected, virtual] |
Add bookmarks.
virtual void wxPdfDocument::PutCatalog | ( | ) | [protected, virtual] |
Addcatalog.
virtual void wxPdfDocument::PutEncryption | ( | ) | [protected, virtual] |
Add encryption info.
virtual void wxPdfDocument::PutExtGStates | ( | ) | [protected, virtual] |
Add extended graphics states.
virtual void wxPdfDocument::PutFonts | ( | ) | [protected, virtual] |
Adds fonts.
virtual void wxPdfDocument::PutFormFields | ( | ) | [protected, virtual] |
Add form fields.
virtual void wxPdfDocument::PutHeader | ( | ) | [protected, virtual] |
Add header.
virtual void wxPdfDocument::PutImages | ( | ) | [protected, virtual] |
Add images.
virtual void wxPdfDocument::PutImportedObjects | ( | ) | [protected, virtual] |
Add imported objects.
virtual void wxPdfDocument::PutInfo | ( | ) | [protected, virtual] |
Add info.
virtual void wxPdfDocument::PutJavaScript | ( | ) | [protected, virtual] |
Add Javascript (document level)
virtual void wxPdfDocument::PutLayers | ( | ) | [protected, virtual] |
Add layers.
void wxPdfDocument::PutOCGOrder | ( | wxPdfLayer * | layer | ) | [protected] |
Add optional content order.
void wxPdfDocument::PutOCProperties | ( | ) | [protected] |
Add optional content properties.
virtual void wxPdfDocument::PutPages | ( | ) | [protected, virtual] |
Add pages.
virtual void wxPdfDocument::PutPatterns | ( | ) | [protected, virtual] |
Add patterns.
virtual void wxPdfDocument::PutResourceDict | ( | ) | [protected, virtual] |
Add resource dictionary.
virtual void wxPdfDocument::PutResources | ( | ) | [protected, virtual] |
Add resources.
virtual void wxPdfDocument::PutShaders | ( | ) | [protected, virtual] |
Add shaders.
virtual void wxPdfDocument::PutSpotColours | ( | ) | [protected, virtual] |
Add spot colours.
void wxPdfDocument::PutStream | ( | wxMemoryOutputStream & | s | ) | [protected] |
Add byte stream.
virtual void wxPdfDocument::PutTemplates | ( | ) | [protected, virtual] |
Add templates.
virtual void wxPdfDocument::PutTrailer | ( | ) | [protected, virtual] |
Add trailer.
virtual void wxPdfDocument::PutXObjectDict | ( | ) | [protected, virtual] |
Add object dictionary.
virtual int wxPdfDocument::RadialGradient | ( | const wxPdfColour & | col1, |
const wxPdfColour & | col2, | ||
double | x1 = 0.5 , |
||
double | y1 = 0.5 , |
||
double | r1 = 0 , |
||
double | x2 = 0.5 , |
||
double | y2 = 0.5 , |
||
double | r2 = 1 , |
||
double | intexp = 1 |
||
) | [virtual] |
Defines a radial gradient shading.
col1 | first colour (RGB or CMYK). |
col2 | second colour (RGB or CMYK). |
x1 | center point of circle 1, default: 0.5 (range 0 .. 1) |
y1 | center point of circle 1, default: 0.5 (range 0 .. 1) |
r1 | radius of circle 1, default: 0 |
x2 | center point of circle 2, default: 0.5 (range 0 .. 1) |
y2 | center point of circle 2, default: 0.5 (range 0 .. 1) |
r2 | radius of circle 2, default: 1 |
intexp | interpolation exponent, default: 1 |
virtual void wxPdfDocument::RadioButton | ( | const wxString & | group, |
const wxString & | name, | ||
double | width | ||
) | [virtual] |
Adds a radio button at the current position.
Adds a radio button to the list of form fields at the current position
group | name of the radio button group this radio button belongs to |
name | field name of the radio button |
width | width of the radio button |
virtual void wxPdfDocument::RadioButton | ( | const wxString & | group, |
const wxString & | name, | ||
double | x, | ||
double | y, | ||
double | width | ||
) | [virtual] |
Adds a radio button.
Adds a radio button to the list of form fields
group | name of the radio button group this radio button belongs to |
name | field name of the radio button |
x | abscissa of the radio button position |
y | ordinate of the radio button position |
width | width of the radio button |
virtual void wxPdfDocument::Rect | ( | double | x, |
double | y, | ||
double | w, | ||
double | h, | ||
int | style = wxPDF_STYLE_DRAW |
||
) | [virtual] |
Outputs a rectangle.
It can be drawn (border only), filled (with no border) or both.
x | Abscissa of upper-left corner |
y | Ordinate of upper-left corner |
w | Width |
h | Height |
style | Style of rendering. Possible values are:
|
virtual void wxPdfDocument::RegularPolygon | ( | double | x0, |
double | y0, | ||
double | r, | ||
int | ns, | ||
double | angle = 0 , |
||
bool | circle = false , |
||
int | style = wxPDF_STYLE_DRAW , |
||
int | circleStyle = wxPDF_STYLE_DRAW , |
||
const wxPdfLineStyle & | circleLineStyle = wxPdfLineStyle() , |
||
const wxPdfColour & | circleFillColour = wxPdfColour() |
||
) | [virtual] |
Draws a regular polygon.
x0,: | Abscissa of Center point |
y0,: | Ordinate of Center point |
r,: | Radius of circumscribed circle |
ns,: | Number of sides |
angle,: | Orientation angle (anti-clockwise) |
circle,: | Flag whether to draw circumscribed circle or not |
style,: | Style of polygon (draw and/or fill) |
circleStyle,: | Style of circumscribed circle (draw and/or fill) (if draw) |
circleLineStyle,: | Line style for circumscribed circle. (if draw) |
circleFillColour,: | Fill colour for circumscribed circle. (if draw fill circle) |
virtual void wxPdfDocument::ReplaceNbPagesAlias | ( | ) | [protected, virtual] |
Replace page number aliases.
virtual void wxPdfDocument::RestoreGraphicState | ( | ) | [protected, virtual] |
Restore graphic state.
virtual void wxPdfDocument::Rotate | ( | double | angle, |
double | x = -1 , |
||
double | y = -1 |
||
) | [virtual] |
Performs a rotation around a given center.
angle | angle in degrees. |
x | abscissa of the rotation center. Default value: current position. |
y | ordinate of the rotation center. Default value: current position. |
The rotation affects all elements which are printed after the method call (with the exception of the clickable areas).
Remarks:
virtual void wxPdfDocument::RotatedImage | ( | const wxString & | file, |
double | x, | ||
double | y, | ||
double | w, | ||
double | h, | ||
double | angle, | ||
const wxString & | type = wxEmptyString , |
||
const wxPdfLink & | link = wxPdfLink(-1) , |
||
int | maskImage = 0 |
||
) | [virtual] |
Puts a rotated image in the page.
The upper-left corner must be given.
The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.
Remark: if an image is used several times, only one copy will be embedded in the file.
file | Name of the file containing the image. |
x | Abscissa of the upper-left corner. |
y | Ordinate of the upper-left corner. |
w | Width of the image in the page. If not specified or equal to zero, it is automatically calculated. |
h | Height of the image in the page. If not specified or equal to zero, it is automatically calculated. |
angle | Angle of rotation |
type | Image format. Possible values are (case insensitive): JPG, JPEG, PNG, GIF, WMF. If not specified, the type is inferred from the file extension. |
link | URL or identifier returned by AddLink(). |
maskImage | Id of an image mask created previously by ImageMask(). |
virtual void wxPdfDocument::RotatedText | ( | double | x, |
double | y, | ||
const wxString & | txt, | ||
double | angle | ||
) | [virtual] |
Prints a rotated text string.
x,: | abscissa of the rotation center. |
y,: | ordinate of the rotation center. |
txt | String to print |
angle,: | angle in degrees. |
virtual void wxPdfDocument::RoundedRect | ( | double | x, |
double | y, | ||
double | w, | ||
double | h, | ||
double | r, | ||
int | roundCorner = wxPDF_CORNER_ALL , |
||
int | style = wxPDF_STYLE_DRAW |
||
) | [virtual] |
Draws a rounded rectangle.
x | Abscissa of upper-left corner |
y | Ordinate of upper-left corner |
w | Width |
h | Height |
r,: | Radius of the rounded corners |
roundCorner,: | Draws rounded corner or not.
|
style,: | Style of rectangle (draw and/or fill) |
virtual void wxPdfDocument::SaveAsFile | ( | const wxString & | name = wxEmptyString | ) | [virtual] |
virtual void wxPdfDocument::SaveGraphicState | ( | ) | [protected, virtual] |
Save graphic state.
virtual bool wxPdfDocument::Scale | ( | double | sx, |
double | sy, | ||
double | x = -1 , |
||
double | y = -1 |
||
) | [virtual] |
Performs scaling in X and Y direction.
A scaling transformation is applied independently for X and Y direction.
sx,: | scaling factor for width in percent. 0 is not allowed. |
sy,: | scaling factor for height in percent. 0 is not allowed. |
x,: | abscissa of the scaling center. Default is current x position |
y,: | ordinate of the scaling center. Default is current y position |
virtual bool wxPdfDocument::ScaleX | ( | double | sx, |
double | x = -1 , |
||
double | y = -1 |
||
) | [virtual] |
Performs scaling in X direction only.
A scaling transformation is applied for the X direction.
sx,: | scaling factor for width as percent. 0 is not allowed. |
x,: | abscissa of the scaling center. Default is current x position |
y,: | ordinate of the scaling center. Default is current y position |
virtual bool wxPdfDocument::ScaleXY | ( | double | s, |
double | x = -1 , |
||
double | y = -1 |
||
) | [virtual] |
Performs equal scaling in X and Y direction.
A scaling transformation is applied for both - X and Y - directions.
s,: | scaling factor for width and height as percent. 0 is not allowed. |
x,: | abscissa of the scaling center. Default is current x position |
y,: | ordinate of the scaling center. Default is current y position |
virtual bool wxPdfDocument::ScaleY | ( | double | sy, |
double | x = -1 , |
||
double | y = -1 |
||
) | [virtual] |
Performs scaling in Y direction only.
A scaling transformation is applied for the Y direction.
sy,: | scaling factor for height as percent. 0 is not allowed. |
x,: | abscissa of the scaling center. Default is current x position |
y,: | ordinate of the scaling center. Default is current y position |
virtual void wxPdfDocument::Sector | ( | double | x0, |
double | y0, | ||
double | r, | ||
double | astart, | ||
double | afinish, | ||
int | style = wxPDF_STYLE_FILLDRAW , |
||
bool | clockwise = true , |
||
double | origin = 90. |
||
) | [virtual] |
Draws a sector.
x0,: | Abscissa of Center point |
y0,: | Ordinate of Center point |
r,: | Radius |
astart,: | Start angle |
afinish,: | Finish angle |
style,: | Style of rectangle (draw and/or fill, default: fill&draw) |
clockwise,: | indicates whether to go clockwise (default: true) |
origin,: | origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock; default: 90) |
virtual bool wxPdfDocument::SelectFont | ( | const wxPdfFont & | font, |
int | style, | ||
double | size = 0 , |
||
bool | setFont = true |
||
) | [protected, virtual] |
Select font based on wxFont object.
virtual bool wxPdfDocument::SelectFont | ( | const wxString & | family, |
const wxString & | style = wxEmptyString , |
||
double | size = 0 , |
||
bool | setFont = true |
||
) | [protected, virtual] |
Select font.
virtual bool wxPdfDocument::SelectFont | ( | const wxString & | family, |
int | style, | ||
double | size = 0 , |
||
bool | setFont = true |
||
) | [protected, virtual] |
Select font.
virtual bool wxPdfDocument::SelectFont | ( | const wxFont & | font, |
bool | setFont = true |
||
) | [protected, virtual] |
Select font based on wxFont object.
virtual int wxPdfDocument::SetAlpha | ( | double | lineAlpha = 1 , |
double | fillAlpha = 1 , |
||
wxPdfBlendMode | blendMode = wxPDF_BLENDMODE_NORMAL |
||
) | [virtual] |
Sets alpha values and blend mode.
lineAlpha | alpha value for stroking operations, from 0 (transparent) to 1 (opaque) |
fillAlpha | alpha value for non-stroking operations, from 0 (transparent) to 1 (opaque) |
blendMode | one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity |
virtual void wxPdfDocument::SetAlphaState | ( | int | alphaState | ) | [virtual] |
Sets a previously defined alpha state.
alphaState | id of alpha state |
virtual void wxPdfDocument::SetAuthor | ( | const wxString & | author | ) | [virtual] |
Defines the author of the document.
author | The name of the author. |
virtual void wxPdfDocument::SetAutoPageBreak | ( | bool | autoPageBreak, |
double | margin = 0 |
||
) | [virtual] |
Enables or disables the automatic page breaking mode.
When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.
autoPageBreak | Boolean indicating if mode should be on or off. |
margin | Distance from the bottom of the page. |
virtual void wxPdfDocument::SetCellMargin | ( | double | margin | ) | [virtual] |
Defines the cell margin.
The method can be called before creating the first page.
margin | The margin. |
virtual void wxPdfDocument::SetCompression | ( | bool | compress | ) | [virtual] |
Activates or deactivates page compression.
When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.
compress | Boolean indicating if compression must be enabled. |
virtual void wxPdfDocument::SetCreator | ( | const wxString & | creator | ) | [virtual] |
Defines the creator of the document.
This is typically the name of the application that generates the PDF.
creator | The name of the creator. |
virtual void wxPdfDocument::SetDisplayMode | ( | wxPdfZoom | zoom, |
wxPdfLayout | layout = wxPDF_LAYOUT_CONTINUOUS , |
||
double | zoomFactor = 100. |
||
) | [virtual] |
Defines the way the document is to be displayed by the viewer.
The zoom level can be set:pages can be displayed entirely on screen, occupy the full width of the window, use real size, be scaled by a specific zooming factor or use viewer default (configured in the Preferences menu of Acrobat). The page layout can be specified too: single at once, continuous display, two columns or viewer default. By default, documents use the full width mode with continuous display.
zoom | The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use.
|
layout | The page layout. Possible values are:
|
zoomFactor | specifies the zoom factor in percent if layout is wxPDF_ZOOM_FACTOR |
virtual void wxPdfDocument::SetDrawColour | ( | const unsigned char | red, |
const unsigned char | green, | ||
const unsigned char | blue | ||
) | [virtual] |
Defines the colour used for all drawing operations.
Affected drawing operations are: lines, rectangles and cell borders. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
red | indicates the red level. Value between 0 and 255 |
green | indicates the green level. Value between 0 and 255 |
blue | indicates the blue level. Value between 0 and 255 |
virtual void wxPdfDocument::SetDrawColour | ( | const unsigned char | grayscale | ) | [virtual] |
Defines the colour used for all drawing operations.
Affected drawing operations are: lines, rectangles and cell borders. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
grayscale | indicates the gray level. Value between 0 and 255 |
virtual void wxPdfDocument::SetDrawColour | ( | const wxColour & | colour | ) | [virtual] |
Defines the colour used for all drawing operations.
Affected drawing operations are: lines, rectangles and cell borders. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
colour | defines a colour composed of a red, green and blue component |
virtual void wxPdfDocument::SetDrawColour | ( | const wxPdfColour & | colour | ) | [virtual] |
Defines the colour used for all drawing operations.
Affected drawing operations are: lines, rectangles and cell borders. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
colour | defines a colour using the class wxPdfColour |
virtual void wxPdfDocument::SetDrawColour | ( | double | cyan, |
double | magenta, | ||
double | yellow, | ||
double | black | ||
) | [virtual] |
Defines the colour used for all drawing operations.
Affected drawing operations are: lines, rectangles and cell borders. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
cyan | indicates the cyan level. Value between 0 and 100 |
magenta | indicates the magenta level. Value between 0 and 100 |
yellow | indicates the yellow level. Value between 0 and 100 |
black | indicates the black level. Value between 0 and 100 |
virtual void wxPdfDocument::SetDrawColour | ( | const wxString & | name, |
double | tint = 100 |
||
) | [virtual] |
Defines the spot colour used for all drawing operations.
Affected drawing operations are: lines, rectangles and cell borders. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
name | the name of the spot colour |
tint | indicates the tint level. Value between 0 and 100. Default: 100. |
virtual void wxPdfDocument::SetDrawPattern | ( | const wxString & | name | ) | [virtual] |
Defines the pattern used for all drawing operations.
The given pattern is used for all drawing operations instead of a colour. Affected drawing operations are: lines, rectangles and cell borders. The method can be called before the first page is created and the value is retained from page to page.
name | the name of the pattern |
virtual void wxPdfDocument::SetFillColour | ( | double | cyan, |
double | magenta, | ||
double | yellow, | ||
double | black | ||
) | [virtual] |
Defines the colour used for all filling operations.
Affected filling operations are: filled rectangles and cell backgrounds. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
cyan | indicates the cyan level. Value between 0 and 100 |
magenta | indicates the magenta level. Value between 0 and 100 |
yellow | indicates the yellow level. Value between 0 and 100 |
black | indicates the black level. Value between 0 and 100 |
virtual void wxPdfDocument::SetFillColour | ( | const unsigned char | red, |
const unsigned char | green, | ||
const unsigned char | blue | ||
) | [virtual] |
Defines the colour used for all filling operations.
Affected filling operations are: filled rectangles and cell backgrounds. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
red | indicates the red level. Value between 0 and 255 |
green | indicates the green level. Value between 0 and 255 |
blue | indicates the blue level. Value between 0 and 255 |
virtual void wxPdfDocument::SetFillColour | ( | const wxColour & | colour | ) | [virtual] |
Defines the colour used for all filling operations.
Affected filling operations are: filled rectangles and cell backgrounds. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
colour | defines a colour composed of a red, green and blue component |
virtual void wxPdfDocument::SetFillColour | ( | const unsigned char | grayscale | ) | [virtual] |
Defines the colour used for all filling operations.
Affected filling operations are: filled rectangles and cell backgrounds. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
grayscale | indicates the gray level. Value between 0 and 255 |
virtual void wxPdfDocument::SetFillColour | ( | const wxString & | name, |
double | tint = 100 |
||
) | [virtual] |
Defines the spot colour used for all filling operations.
Affected filling operations are: filled rectangles and cell backgrounds. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
name | is the name of the spot colour |
tint | indicates the tint level. Value between 0 and 100. Default: 100. |
virtual void wxPdfDocument::SetFillColour | ( | const wxPdfColour & | colour | ) | [virtual] |
Defines the colour used for all filling operations.
Affected filling operations are: filled rectangles and cell backgrounds. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
colour | defines a colour using the class wxPdfColour |
virtual void wxPdfDocument::SetFillGradient | ( | double | x, |
double | y, | ||
double | w, | ||
double | h, | ||
int | gradient | ||
) | [virtual] |
Paints a gradient shading to rectangular area.
x | abscissa of the top left corner of the rectangle. |
y | ordinate of the top left corner of the rectangle. |
w | width of the rectangle. |
h | height of the rectangle. |
gradient | id of the gradient. |
virtual void wxPdfDocument::SetFillingRule | ( | int | rule = wxWINDING_RULE | ) | [virtual] |
Set the filling rule.
rule | The filling rule to be used in complex filling operations. Possible values are:
|
virtual void wxPdfDocument::SetFillPattern | ( | const wxString & | name | ) | [virtual] |
Defines the pattern used for all filling operations.
The given pattern is used for all filling operations instead of a colour. Affected filling operations are: filled rectangles and cell backgrounds. The method can be called before the first page is created and the value is retained from page to page.
name | the name of the pattern |
virtual bool wxPdfDocument::SetFont | ( | const wxFont & | font | ) | [virtual] |
Sets the font used to print character strings based on a wxFont object.
The font referenced by the wxFont object will be added to the document if necessary.
font | The font to be set. |
virtual bool wxPdfDocument::SetFont | ( | const wxString & | family, |
const wxString & | style = wxEmptyString , |
||
double | size = 0 |
||
) | [virtual] |
Sets the font used to print character strings.
It is mandatory to call a variant of this method at least once before printing text or the resulting document would not be valid. The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize().
family | Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):
|
style | Font style. Possible values are (case insensitive):
|
size | Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12 |
virtual bool wxPdfDocument::SetFont | ( | const wxPdfFont & | font, |
int | style = wxPDF_FONTSTYLE_REGULAR , |
||
double | size = 0 |
||
) | [virtual] |
Sets the font used to print character strings based on a wxFont object.
The font referenced by the wxFont object will be added to the document if necessary.
font | The font to be set. |
style | Font style. Possible values are (case insensitive):
|
size | Font size in points. The default value is the current size. If no size has been |
virtual bool wxPdfDocument::SetFont | ( | const wxString & | family, |
int | style, | ||
double | size = 0 |
||
) | [virtual] |
Sets the font used to print character strings.
It is mandatory to call a variant of this method at least once before printing text or the resulting document would not be valid. The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize().
family | Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):
|
style | Font style. Possible values are (case insensitive):
|
size | Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12 |
virtual void wxPdfDocument::SetFontSize | ( | double | size | ) | [virtual] |
virtual void wxPdfDocument::SetFontSubsetting | ( | bool | fontSubsetting = true | ) | [inline, virtual] |
Sets the font embedding mode.
If other fonts than the 14 Adobe core fonts are used in a document, they are usually embedded into the PDF file, often resulting in rather large PDF files. This is especially true for Unicode fonts with thousands of glyphs. To reduce the size of the resulting PDF file fonts may be subsetted, that is, only those glyphs actually used in the document are embedded.
Currently wxPdfDocument supports font subsetting for TrueType Unicode fonts only.
fontSubsetting | Boolean indicating whether font subsetting should be used or not. |
virtual void wxPdfDocument::SetFormBorderStyle | ( | wxPdfBorderStyle | borderStyle = wxPDF_BORDER_SOLID , |
double | borderWidth = -1 |
||
) | [virtual] |
Sets the border style for form fields.
Sets the border width and style to be used for all subsequent form field additions until this method is called again with different values.
borderStyle | style of the form field's border
|
borderWidth | width of the form field's border |
virtual void wxPdfDocument::SetFormColours | ( | const wxPdfColour & | borderColour = wxPdfColour() , |
const wxPdfColour & | backgroundColour = wxPdfColour(250) , |
||
const wxPdfColour & | textColour = wxPdfColour() |
||
) | [virtual] |
Sets colours for form fields.
Sets the border, background and text colour to be used for all subsequent form field additions until this method is called again with different values.
borderColour | colour of the form field's border |
backgroundColour | colour of the form field's background |
textColour | colour of the form field's font |
virtual void wxPdfDocument::SetImageScale | ( | double | scale | ) | [virtual] |
Set the image scale.
[in] | scale | image scale. |
virtual void wxPdfDocument::SetKerning | ( | bool | kerning | ) | [virtual] |
Enable or disable kerning.
When enabled, kerning is applied to text output. Kerning is disabled by default.
kerning | Boolean indicating if kerning should be enabled. |
virtual void wxPdfDocument::SetKeywords | ( | const wxString & | keywords | ) | [virtual] |
Associates keywords with the document,.
Generally keywords are in the form 'keyword1 keyword2 ...'.
keywords | The list of keywords. |
virtual void wxPdfDocument::SetLeftMargin | ( | double | margin | ) | [virtual] |
Defines the left margin.
The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.
margin | The margin. |
virtual void wxPdfDocument::SetLineHeight | ( | double | height | ) | [virtual] |
Sets the height of a text line.
height | The line height. |
virtual void wxPdfDocument::SetLineStyle | ( | const wxPdfLineStyle & | linestyle | ) | [virtual] |
Sets line style.
linestyle,: | Line style. |
virtual void wxPdfDocument::SetLineWidth | ( | double | width | ) | [virtual] |
Defines the line width.
By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.
width | The width. |
virtual bool wxPdfDocument::SetLink | ( | int | link, |
double | y = 0. , |
||
int | page = -1 |
||
) | [virtual] |
Defines the page and position a link points to.
link | The link identifier returned by AddLink() |
y | Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page) |
page | Number of target page; -1 indicates the current page. This is the default value |
virtual void wxPdfDocument::SetMargins | ( | double | left, |
double | top, | ||
double | right = -1 |
||
) | [virtual] |
Defines the left, top and right margins.
By default, they equal 1 cm. Call this method to change them.
left | Left margin. |
top | Top margin. |
right | Right margin. Default value is the left one. |
void wxPdfDocument::SetMessageTranslateMode | ( | bool | translate | ) | [inline] |
Set message translation mode.
Sets the message translation mode which controls the handling of msg tags in XML output
translate | flag specifying whether messages translation should be enabled |
virtual void wxPdfDocument::SetProtection | ( | int | permissions, |
const wxString & | userPassword = wxEmptyString , |
||
const wxString & | ownerPassword = wxEmptyString , |
||
wxPdfEncryptionMethod | encryptionMethod = wxPDF_ENCRYPTION_RC4V1 , |
||
int | keyLength = 0 |
||
) | [virtual] |
Set permissions as well as user and owner passwords.
permissions | flag indicating permissions. Flags from the following list may be combined as needed If a value is present it means that the permission is granted |
userPassword | user password if applicable. If a user password is set, user will be prompted before document is opened |
ownerPassword | owner password.if applicable If an owner password is set, the document can be opened in privilege mode with no restriction if that password is entered |
encryptionMethod | selects the encryption method. Possible values are:
|
keyLength | Length of the key used for encryption (Default: 0) The default value selects the standard encryption method revision 2 with a key length of 40 bits. Specifying a value > 0 selects the standard encryption method revision 3 with the given key length, the key length has to be in the range 40..128 and has to be dividable by 8. The key length is adjusted accordingly if these conditions are not met. NOTE: Adobe Reader supports only 40- and 128-bit encryption keys. |
virtual void wxPdfDocument::SetRightMargin | ( | double | margin | ) | [virtual] |
Defines the right margin.
The method can be called before creating the first page.
margin | The margin. |
void wxPdfDocument::SetScaleFactor | ( | const wxString & | unit | ) | [protected] |
Set internal scale factor.
virtual int wxPdfDocument::SetSourceFile | ( | const wxString & | filename, |
const wxString & | password = wxEmptyString |
||
) | [virtual] |
Sets a source file for the external template feature.
Selects the source for the external template feature. A parser is setup for importing pages from the PDF document. Although wxPdfDocument usually creates PDF documents conforming to version 1.3 of the PDF standard, parsing of documents conforming to versions up to 1.6 is supported. If pages are aimported from documents conforming to a higher version than 1.3 the version used by wxPdDocument is updated accordingly.
filename | a valid filename |
password | a valid user or owner password if the PDF document is encrypted |
Attention: Access permissions for printing, copying and extracting text or graphics are required. If a PDF document does not have these access permissions, it cannot be used as a source for the external template feature.
virtual void wxPdfDocument::SetSubject | ( | const wxString & | subject | ) | [virtual] |
Defines the subject of the document.
subject | The subject. |
virtual void wxPdfDocument::SetTemplateBBox | ( | int | templateId, |
double | x, | ||
double | y, | ||
double | width, | ||
double | height | ||
) | [virtual] |
Sets the bounding box of a template.
As long as a template hasn't been used it is possible to change the bounding box of the template. This may be useful for pages imported from an external PDF document allowing to set the visible portion of the template. Note: Setting the bounding box influences only the visible area of the template, not the real size it occupies.
templateId | A valid template ID |
x | The x coordinate of the lower left corner |
y | The y coordinate of the lower left corner |
width | The width of the template |
height | The height of the template |
virtual void wxPdfDocument::SetTextColour | ( | double | cyan, |
double | magenta, | ||
double | yellow, | ||
double | black | ||
) | [virtual] |
Defines the colour used for text.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
cyan | indicates the cyan level. Value between 0 and 100 |
magenta | indicates the magenta level. Value between 0 and 100 |
yellow | indicates the yellow level. Value between 0 and 100 |
black | indicates the black level. Value between 0 and 100 |
virtual void wxPdfDocument::SetTextColour | ( | const unsigned char | red, |
const unsigned char | green, | ||
const unsigned char | blue | ||
) | [virtual] |
Defines the colour used for text.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
red | indicates the red level. Value between 0 and 255 |
green | indicates the green level. Value between 0 and 255 |
blue | indicates the blue level. Value between 0 and 255 |
virtual void wxPdfDocument::SetTextColour | ( | const wxPdfColour & | colour | ) | [virtual] |
Defines the colour used for text.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
colour | defines a colour using the class wxPdfColour |
virtual void wxPdfDocument::SetTextColour | ( | const wxString & | name, |
double | tint = 100 |
||
) | [virtual] |
Defines the spot colour used for text.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
name | the name of the spot colour |
tint | indicates the tint level. Value between 0 and 100. Default: 100. |
virtual void wxPdfDocument::SetTextColour | ( | const wxColour & | colour | ) | [virtual] |
Defines the colour used for text.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
colour | defines a colour composed of a red, green and blue component |
virtual void wxPdfDocument::SetTextColour | ( | const unsigned char | grayscale | ) | [virtual] |
Defines the colour used for text.
It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
grayscale | indicates the gray level. Value between 0 and 255 |
virtual void wxPdfDocument::SetTextPattern | ( | const wxString & | name | ) | [virtual] |
Defines the pattern used for text output.
The given pattern is used for text output instead of a colour. The method can be called before the first page is created and the value is retained from page to page.
name | the name of the pattern |
virtual void wxPdfDocument::SetTextRenderMode | ( | wxPdfTextRenderMode | mode = wxPDF_TEXT_RENDER_FILL | ) | [virtual] |
Sets the text render mode.
mode | the text render mode |
virtual void wxPdfDocument::SetTitle | ( | const wxString & | title | ) | [virtual] |
Defines the title of the document.
title | The title. |
virtual void wxPdfDocument::SetTopMargin | ( | double | margin | ) | [virtual] |
Defines the top margin.
The method can be called before creating the first page.
margin | The margin. |
virtual void wxPdfDocument::SetViewerPreferences | ( | int | preferences = 0 | ) | [virtual] |
Defines the viewer preferences.
preferences | A set of viewer preferences options.
|
virtual void wxPdfDocument::SetX | ( | double | x | ) | [virtual] |
virtual void wxPdfDocument::SetXY | ( | double | x, |
double | y | ||
) | [virtual] |
virtual void wxPdfDocument::SetY | ( | double | y | ) | [virtual] |
virtual void wxPdfDocument::Shape | ( | const wxPdfShape & | shape, |
int | style = wxPDF_STYLE_DRAW |
||
) | [virtual] |
Draws a shape.
shape,: | shape to be drawn |
style | Style of rendering. Possible values are:
|
virtual void wxPdfDocument::ShapedText | ( | const wxPdfShape & | shape, |
const wxString & | text, | ||
wxPdfShapedTextMode | mode = wxPDF_SHAPEDTEXTMODE_STRETCHTOFIT |
||
) | [virtual] |
Prints a text string along a path defined by a shape.
shape | shape defining a path along which the text is printed |
text | text string to be printed |
mode | flag how to handle the text string
|
void wxPdfDocument::ShowGlyph | ( | wxUint32 | glyph | ) | [protected] |
Show a single glyph.
void wxPdfDocument::ShowText | ( | const wxString & | txt | ) | [protected] |
Show text string, with kerning if requested.
virtual bool wxPdfDocument::Skew | ( | double | xAngle, |
double | yAngle, | ||
double | x = -1 , |
||
double | y = -1 |
||
) | [virtual] |
Performs a skewing in both X and Y directions.
xAngle,: | angle in degrees between -90 (skew to the left) and 90 (skew to the right) |
yAngle,: | angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) |
x,: | abscissa of the skewing center. default is current x position |
y,: | ordinate of the skewing center. default is current y position |
virtual bool wxPdfDocument::SkewX | ( | double | xAngle, |
double | x = -1 , |
||
double | y = -1 |
||
) | [virtual] |
Performs a skewing in both X direction only.
xAngle,: | angle in degrees between -90 (skew to the left) and 90 (skew to the right) |
x,: | abscissa of the skewing center. default is current x position |
y,: | ordinate of the skewing center. default is current y position |
virtual bool wxPdfDocument::SkewY | ( | double | yAngle, |
double | x = -1 , |
||
double | y = -1 |
||
) | [virtual] |
Performs a skewing in Y direction only.
yAngle,: | angle in degrees between -90 (skew to the bottom) and 90 (skew to the top) |
x,: | abscissa of the skewing center. default is current x position |
y,: | ordinate of the skewing center. default is current y position |
virtual void wxPdfDocument::StarPolygon | ( | double | x0, |
double | y0, | ||
double | r, | ||
int | nv, | ||
int | ng, | ||
double | angle = 0 , |
||
bool | circle = false , |
||
int | style = wxPDF_STYLE_DRAW , |
||
int | circleStyle = wxPDF_STYLE_DRAW , |
||
const wxPdfLineStyle & | circleLineStyle = wxPdfLineStyle() , |
||
const wxPdfColour & | circleFillColour = wxPdfColour() |
||
) | [virtual] |
Draws a star polygon.
x0,: | Abscissa of Center point |
y0,: | Ordinate of Center point |
r,: | Radius of circumscribed circle |
nv,: | Number of vertices |
ng,: | Number of gaps (ng % nv = 1 => regular polygon) |
angle,: | Orientation angle (anti-clockwise) |
circle,: | Flag whether to draw circumscribed circle or not |
style,: | Style of polygon (draw and/or fill) |
circleStyle,: | Style of circumscribed circle (draw and/or fill) (if draw) |
circleLineStyle,: | Line style for circumscribed circle. (if draw) |
circleFillColour,: | Fill colour for circumscribed circle. (if draw fill circle) |
virtual void wxPdfDocument::StartTransform | ( | ) | [virtual] |
Enters a transformation environment.
Before applying any transformation this method should be invoked. All transformation method invoke it implicitly if necessary. All open transformation environments are closed implicitly on page end.
virtual void wxPdfDocument::StopTransform | ( | ) | [virtual] |
Leaves a transformation environment.
This method should be invoked to cancel a transformation environment opened by StartTransform. All open transformation environments are closed implicitly on page end.
virtual void wxPdfDocument::Text | ( | double | x, |
double | y, | ||
const wxString & | txt | ||
) | [virtual] |
Prints a character string.
The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text.
x | Abscissa of the origin |
y | Ordinate of the origin |
txt | String to print |
virtual int wxPdfDocument::TextBox | ( | double | w, |
double | h, | ||
const wxString & | txt, | ||
int | halign = wxPDF_ALIGN_JUSTIFY , |
||
int | valign = wxPDF_ALIGN_TOP , |
||
int | border = 0 , |
||
int | fill = 0 |
||
) | [virtual] |
This method counts the number of lines a text will occupy in respect to a given maximal width.
w | Width of cells. If 0, they extend up to the right margin of the page. |
h | Height of cells. |
txt | String to print |
halign | Allows to center or align the text. Possible values are:
|
valign | Allows to vertical align the text. Possible values are:
|
border | Indicates if borders must be drawn around the text box. The value can be
|
fill | Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. |
void wxPdfDocument::TextEscape | ( | const wxString & | s, |
bool | newline = true |
||
) | [protected] |
Format a text string.
virtual void wxPdfDocument::TextField | ( | const wxString & | name, |
double | width, | ||
double | height, | ||
const wxString & | value = wxEmptyString , |
||
bool | multiline = false |
||
) | [virtual] |
Adds a text field at the current position.
Adds a text field to the list of form fields at the current position
name | field name of the text field |
width | width of the text field |
height | height of the text field |
value | default value of the text field |
multiline | flag whether the text field is a multiline field or not |
virtual void wxPdfDocument::TextField | ( | const wxString & | name, |
double | x, | ||
double | y, | ||
double | width, | ||
double | height, | ||
const wxString & | value = wxEmptyString , |
||
bool | multiline = false |
||
) | [virtual] |
Adds a text field.
Adds a text field to the list of form fields
name | field name of the text field |
x | abscissa of the text field position |
y | ordinate of the text field position |
width | width of the text field |
height | height of the text field |
value | default value of the text field |
multiline | flag whether the text field is a multiline field or not |
virtual void wxPdfDocument::Transform | ( | double | a, |
double | b, | ||
double | c, | ||
double | d, | ||
double | tx, | ||
double | ty | ||
) | [virtual] |
void wxPdfDocument::Transform | ( | double | tm[6] | ) | [protected] |
Perform transformation.
virtual void wxPdfDocument::Translate | ( | double | tx, |
double | ty | ||
) | [virtual] |
Moves the origin.
tx,: | movement to the right |
ty,: | movement to the bottom |
virtual void wxPdfDocument::TranslateX | ( | double | tx | ) | [virtual] |
Moves the X origin.
tx,: | movement to the right |
virtual void wxPdfDocument::TranslateY | ( | double | ty | ) | [virtual] |
Moves the Y origin.
ty,: | movement to the bottom |
virtual void wxPdfDocument::UnsetClipping | ( | ) | [virtual] |
Remove clipping area.
Once you have finished using the clipping, you must remove it with UnsetClipping().
virtual void wxPdfDocument::UseTemplate | ( | int | templateId, |
double | x = -1 , |
||
double | y = -1 , |
||
double | width = 0 , |
||
double | height = 0 |
||
) | [virtual] |
Uses a template in current page or in another template.
Uses the specified template just like an image in the current page or in another template.
All parameters are optional. The width or height is calculated using GetTemplateSize internally. By default the size as defined by BeginTemplate is used.
templateId | A valid template ID |
x | The x coordinate |
y | The y coordinate |
width | The new width of the template |
height | The new height of the template |
Attention: The template may be displayed distorted, if both width and height are given with values > 0 and do not correspond to the dimensions of the template.
virtual void wxPdfDocument::Write | ( | double | h, |
const wxString & | txt, | ||
const wxPdfLink & | link = wxPdfLink(-1) |
||
) | [virtual] |
This method prints text from the current position.
When the right margin is reached (or the
character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text. It is possible to put a link on the text.
h | Line height |
txt | String to print |
link | URL or identifier returned by AddLink() |
virtual void wxPdfDocument::WriteCell | ( | double | h, |
const wxString & | txt, | ||
int | border = wxPDF_BORDER_NONE , |
||
int | fill = 0 , |
||
const wxPdfLink & | link = wxPdfLink(-1) |
||
) | [virtual] |
This method prints text with cell attributes from the current position.
When the right margin is reached (or the
character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text. It is possible to put a link on the text.
h | Line height |
txt | String to print |
border | Indicates if borders must be drawn around the cell. The value can be
|
fill | Indicates if the cell background must be painted (1) or transparent (0). Default value: 0. |
link | URL or identifier returned by AddLink() |
virtual bool wxPdfDocument::WriteGlyphArray | ( | wxPdfArrayDouble & | x, |
wxPdfArrayDouble & | y, | ||
wxPdfArrayUint32 & | glyphs | ||
) | [virtual] |
Prints an array of glyphs identified by glyph numbers from the current position.
The glyphs are positioned according to the given offsets in horizontal (x) and vertical (y) direction.
virtual void wxPdfDocument::WriteObjectValue | ( | wxPdfObject * | value, |
bool | newline = true |
||
) | [protected, virtual] |
void wxPdfDocument::WriteXml | ( | wxXmlNode * | node | ) | [protected] |
Write XML using XML node.
virtual void wxPdfDocument::WriteXml | ( | const wxString & | str | ) | [virtual] |
Prints a string containing simple XML markup.
Output starts at the current position.
str | string containing text with simple XML markup |
void wxPdfDocument::WriteXmlCell | ( | wxXmlNode * | node, |
wxPdfCellContext & | context | ||
) | [protected] |
Output a prepared XML cell.
void wxPdfDocument::WriteXmlTable | ( | wxPdfCellContext & | context | ) | [protected] |
Output a prepared XML table.
friend class wxPdfImage [friend] |
friend class wxPdfTable [friend] |