docs/latex/wx/dcsvg.tex

   1 \section{\class{wxSVGFileDC}}\label{wxsvgfiledc}
   2
   3 A wxSVGFileDC is a {\it device context} onto which graphics and text can be drawn, and the output
   4 produced as a vector file, in the SVG format
   5 (see \urlref{W3C specifications}{http://www.w3.org/TR/2001/REC-SVG-20010904/}).
   6 This format can be read by a range of programs, including a Netscape plugin (Adobe), full details
   7 in the \urlref{SVG Implementation and Resource Directory}{http://www.svgi.org}.
   8 Vector formats may often be smaller than raster formats.
   9
  10 The intention behind wxSVGFileDC is that it can be used to produce a file corresponding
  11 to the screen display context, wxSVGFileDC, by passing the wxSVGFileDC as a parameter instead of a wxSVGFileDC. Thus the wxSVGFileDC is a write-only class.
  12
  13 As the wxSVGFileDC is a vector format, raster operations like GetPixel are unlikely to be supported.
  14 However, the SVG specification allows for PNG format raster files to be embedded in the SVG, and so
  15 bitmaps, icons and blit operations into the wxSVGFileDC are supported.
  16
  17 A more substantial SVG library (for reading and writing) is available at the
  18 \urlref{wxArt2D website}{http://wxart2d.sourceforge.net/}.
  19
  20 \wxheading{Derived from}
  21
  22 \helpref{wxDC}{wxdc}
  23
  24 \wxheading{Include files}
  25
  26 <wx/dcsvg.h>
  27
  28 \wxheading{Library}
  29
  30 \helpref{wxCore}{librarieslist}
  31
  32 \wxheading{See also}
  33
  34 %\helpref{Overview}{dcoverview}
  35
  36
  37 \latexignore{\rtfignore{\wxheading{Members}}}
  38
  39 \membersection{wxSVGFileDC::wxSVGFileDC}\label{wxsvgfiledcctor}
  40
  41 \func{}{wxSVGFileDC}{\param{wxString}{ f}}
  42
  43 \func{}{wxSVGFileDC}{\param{wxString}{ f}, \param{int}{ Width},\param{int}{ Height}}
  44
  45 \func{}{wxSVGFileDC}{\param{wxString}{ f}, \param{int}{ Width},\param{int}{ Height},\param{float}{ dpi}}
  46
  47 Constructors:
  48 a filename {\it f} with default size 340x240 at 72.0 dots per inch (a frequent screen resolution).
  49 a filename {\it f} with size {\it Width} by {\it Height} at 72.0 dots per inch
  50 a filename {\it f} with size {\it Width} by {\it Height} at {\it dpi} resolution.
  51
  52 \membersection{wxSVGFileDC::\destruct{wxSVGFileDC}}\label{wxsvgfiledcdtor}
  53
  54 \func{}{\destruct{wxSVGFileDC}}{\void}
  55
  56 Destructor.
  57
  58 \membersection{wxSVGFileDC::BeginDrawing}\label{wxsvgfiledcbegindrawing}
  59
  60 Does nothing
  61
  62 \membersection{wxSVGFileDC::Blit}\label{wxsvgfiledcblit}
  63
  64 \func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
  65   \param{wxSVGFileDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY},
  66   \param{bool }{useMask = FALSE}, \param{wxCoord}{ xsrcMask = -1}, \param{wxCoord}{ ysrcMask = -1}}
  67
  68 As wxDC: Copy from a source DC to this DC, specifying the destination
  69 coordinates, size of area to copy, source DC, source coordinates,
  70 logical function, whether to use a bitmap mask, and mask source position.
  71
  72 \membersection{wxSVGFileDC::CalcBoundingBox}\label{wxsvgfiledccalcboundingbox}
  73
  74 \func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}}
  75
  76 Adds the specified point to the bounding box which can be retrieved with
  77 \helpref{MinX}{wxdcminx}, \helpref{MaxX}{wxdcmaxx} and
  78 \helpref{MinY}{wxdcminy}, \helpref{MaxY}{wxdcmaxy} functions.
  79
  80
  81 \membersection{wxSVGFileDC::Clear}\label{wxsvgfiledcclear}
  82
  83 \func{void}{Clear}{\void}
  84
  85 This makes no sense in wxSVGFileDC and does nothing
  86
  87
  88 \membersection{wxSVGFileDC::CrossHair}\label{wxsvgfiledccrosshair}
  89
  90 \func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
  91
  92 Not Implemented
  93
  94 \membersection{wxSVGFileDC::DestroyClippingRegion}\label{wxsvgfiledcdestroyclippingregion}
  95
  96 \func{void}{DestroyClippingRegion}{\void}
  97
  98 Not Implemented
  99
 100 \membersection{wxSVGFileDC::DeviceToLogicalX}\label{wxsvgfiledcdevicetologicalx}
 101
 102 \func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}
 103
 104 Convert device X coordinate to logical coordinate, using the current
 105 mapping mode.
 106
 107 \membersection{wxSVGFileDC::DeviceToLogicalXRel}\label{wxsvgfiledcdevicetologicalxrel}
 108
 109 \func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
 110
 111 Convert device X coordinate to relative logical coordinate, using the current
 112 mapping mode but ignoring the x axis orientation.
 113 Use this function for converting a width, for example.
 114
 115 \membersection{wxSVGFileDC::DeviceToLogicalY}\label{wxsvgfiledcdevicetologicaly}
 116
 117 \func{wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}}
 118
 119 Converts device Y coordinate to logical coordinate, using the current
 120 mapping mode.
 121
 122 \membersection{wxSVGFileDC::DeviceToLogicalYRel}\label{wxsvgfiledcdevicetologicalyrel}
 123
 124 \func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
 125
 126 Convert device Y coordinate to relative logical coordinate, using the current
 127 mapping mode but ignoring the y axis orientation.
 128 Use this function for converting a height, for example.
 129
 130 \membersection{wxSVGFileDC::DrawArc}\label{wxsvgfiledcdrawarc}
 131
 132 \func{void}{DrawArc}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ xc}, \param{wxCoord}{ yc}}
 133
 134 Draws an arc of a circle, centred on ({\it xc, yc}), with starting point ({\it x1, y1})
 135 and ending at ({\it x2, y2}).   The current pen is used for the outline
 136 and the current brush for filling the shape.
 137
 138 The arc is drawn in an anticlockwise direction from the start point to the end point.
 139
 140 \membersection{wxSVGFileDC::DrawBitmap}\label{wxsvgfiledcdrawbitmap}
 141
 142 \func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}}
 143
 144 Draw a bitmap on the device context at the specified point. If {\it transparent} is true and the bitmap has
 145 a transparency mask, the bitmap will be drawn transparently.
 146
 147 When drawing a mono-bitmap, the current text foreground colour will be used to draw the foreground
 148 of the bitmap (all bits set to 1), and the current text background colour to draw the background
 149 (all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground},
 150 \helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
 151
 152 \membersection{wxSVGFileDC::DrawCheckMark}\label{wxsvgfiledcdrawcheckmark}
 153
 154 \func{void}{DrawCheckMark}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 155
 156 \func{void}{DrawCheckMark}{\param{const wxRect \&}{rect}}
 157
 158 Draws a check mark inside the given rectangle.
 159
 160 \membersection{wxSVGFileDC::DrawCircle}\label{wxsvgfiledcdrawcircle}
 161
 162 \func{void}{DrawCircle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ radius}}
 163
 164 \func{void}{DrawCircle}{\param{const wxPoint\&}{ pt}, \param{wxCoord}{ radius}}
 165
 166 Draws a circle with the given centre and radius.
 167
 168 \wxheading{See also}
 169
 170 \helpref{DrawEllipse}{wxdcdrawellipse}
 171
 172 \membersection{wxSVGFileDC::DrawEllipse}\label{wxsvgfiledcdrawellipse}
 173
 174 \func{void}{DrawEllipse}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 175
 176 \func{void}{DrawEllipse}{\param{const wxPoint\&}{ pt}, \param{const wxSize\&}{ size}}
 177
 178 \func{void}{DrawEllipse}{\param{const wxRect\&}{ rect}}
 179
 180 Draws an ellipse contained in the rectangle specified either with the given top
 181 left corner and the given size or directly. The current pen is used for the
 182 outline and the current brush for filling the shape.
 183
 184 \wxheading{See also}
 185
 186 \helpref{DrawCircle}{wxdcdrawcircle}
 187
 188 \membersection{wxSVGFileDC::DrawEllipticArc}\label{wxsvgfiledcdrawellipticarc}
 189
 190 \func{void}{DrawEllipticArc}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
 191  \param{double}{ start}, \param{double}{ end}}
 192
 193 Draws an arc of an ellipse. The current pen is used for drawing the arc and
 194 the current brush is used for drawing the pie.
 195
 196 {\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
 197 the ellipse.
 198
 199 {\it width} and {\it height} specify the width and height of the rectangle that contains
 200 the ellipse.
 201
 202 {\it start} and {\it end} specify the start and end of the arc relative to the three-o'clock
 203 position from the center of the rectangle. Angles are specified
 204 in degrees (360 is a complete circle). Positive values mean
 205 counter-clockwise motion. If {\it start} is equal to {\it end}, a
 206 complete ellipse will be drawn.
 207
 208 \membersection{wxSVGFileDC::DrawIcon}\label{wxsvgfiledcdrawicon}
 209
 210 \func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
 211
 212 Draw an icon on the display (does nothing if the device context is PostScript).
 213 This can be the simplest way of drawing bitmaps on a window.
 214
 215 \membersection{wxSVGFileDC::DrawLine}\label{wxsvgfiledcdrawline}
 216
 217 \func{void}{DrawLine}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}}
 218
 219 Draws a line from the first point to the second. The current pen is used
 220 for drawing the line.
 221
 222 \membersection{wxSVGFileDC::DrawLines}\label{wxsvgfiledcdrawlines}
 223
 224 \func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
 225
 226 \func{void}{DrawLines}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
 227
 228 Draws lines using an array of {\it points} of size {\it n}, or list of
 229 pointers to points, adding the optional offset coordinate. The current
 230 pen is used for drawing the lines.  The programmer is responsible for
 231 deleting the list of points.
 232
 233 \membersection{wxSVGFileDC::DrawPolygon}\label{wxsvgfiledcdrawpolygon}
 234
 235 \func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
 236   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 237
 238 \func{void}{DrawPolygon}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
 239   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 240
 241 Draws a filled polygon using an array of {\it points} of size {\it n},
 242 or list of pointers to points, adding the optional offset coordinate.
 243
 244 The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the
 245 default) or {\bf wxWINDING\_RULE}.
 246
 247 The current pen is used for drawing the outline, and the current brush
 248 for filling the shape.  Using a transparent brush suppresses filling.
 249 The programmer is responsible for deleting the list of points.
 250
 251 Note that wxWindows automatically closes the first and last points.
 252
 253
 254 \membersection{wxSVGFileDC::DrawPoint}\label{wxsvgfiledcdrawpoint}
 255
 256 \func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
 257
 258 Draws a point using the current pen.
 259
 260 \membersection{wxSVGFileDC::DrawRectangle}\label{wxsvgfiledcdrawrectangle}
 261
 262 \func{void}{DrawRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 263
 264 Draws a rectangle with the given top left corner, and with the given
 265 size.  The current pen is used for the outline and the current brush
 266 for filling the shape.
 267
 268 \membersection{wxSVGFileDC::DrawRotatedText}\label{wxsvgfiledcdrawrotatedtext}
 269
 270 \func{void}{DrawRotatedText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{double}{ angle}}
 271
 272 Draws the text rotated by {\it angle} degrees.
 273
 274 The wxMSW wxDC and wxSVGFileDC rotate the text around slightly different points, depending on the size of the font
 275
 276 \membersection{wxSVGFileDC::DrawRoundedRectangle}\label{wxsvgfiledcdrawroundedrectangle}
 277
 278 \func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius = 20}}
 279
 280 Draws a rectangle with the given top left corner, and with the given
 281 size.  The corners are quarter-circles using the given radius. The
 282 current pen is used for the outline and the current brush for filling
 283 the shape.
 284
 285 If {\it radius} is positive, the value is assumed to be the
 286 radius of the rounded corner. If {\it radius} is negative,
 287 the absolute value is assumed to be the {\it proportion} of the smallest
 288 dimension of the rectangle. This means that the corner can be
 289 a sensible size relative to the size of the rectangle, and also avoids
 290 the strange effects X produces when the corners are too big for
 291 the rectangle.
 292
 293 \membersection{wxSVGFileDC::DrawSpline}\label{wxsvgfiledcdrawspline}
 294
 295 \func{void}{DrawSpline}{\param{wxList *}{points}}
 296
 297 Draws a spline between all given control points, using the current
 298 pen.  Doesn't delete the wxList and contents. The spline is drawn
 299 using a series of lines, using an algorithm taken from the X drawing
 300 program `XFIG'.
 301
 302 \func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}}
 303
 304 Draws a three-point spline using the current pen.
 305
 306 \membersection{wxSVGFileDC::DrawText}\label{wxsvgfiledcdrawtext}
 307
 308 \func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
 309
 310 Draws a text string at the specified point, using the current text font,
 311 and the current text foreground and background colours.
 312
 313 The coordinates refer to the top-left corner of the rectangle bounding
 314 the string. See \helpref{wxSVGFileDC::GetTextExtent}{wxdcgettextextent} for how
 315 to get the dimensions of a text string, which can be used to position the
 316 text more precisely.
 317
 318
 319
 320 \membersection{wxSVGFileDC::EndDoc}\label{wxsvgfiledcenddoc}
 321
 322 \func{void}{EndDoc}{\void}
 323
 324 Does nothing
 325
 326 \membersection{wxSVGFileDC::EndDrawing}\label{wxsvgfiledcenddrawing}
 327
 328 \func{void}{EndDrawing}{\void}
 329
 330 Does nothing
 331
 332 \membersection{wxSVGFileDC::EndPage}\label{wxsvgfiledcendpage}
 333
 334 \func{void}{EndPage}{\void}
 335
 336 Does nothing
 337
 338 \membersection{wxSVGFileDC::FloodFill}\label{wxsvgfiledcfloodfill}
 339
 340 \func{void}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}}
 341
 342 Not implemented
 343
 344 \membersection{wxSVGFileDC::GetBackground}\label{wxsvgfiledcgetbackground}
 345
 346 \func{wxBrush\&}{GetBackground}{\void}
 347
 348 \constfunc{const wxBrush\&}{GetBackground}{\void}
 349
 350 Gets the brush used for painting the background (see \helpref{wxSVGFileDC::SetBackground}{wxdcsetbackground}).
 351
 352 \membersection{wxSVGFileDC::GetBackgroundMode}\label{wxsvgfiledcgetbackgroundmode}
 353
 354 \constfunc{int}{GetBackgroundMode}{\void}
 355
 356 Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
 357
 358 \wxheading{See also}
 359
 360 \helpref{SetBackgroundMode}{wxdcsetbackgroundmode}
 361
 362 \membersection{wxSVGFileDC::GetBrush}\label{wxsvgfiledcgetbrush}
 363
 364 \func{wxBrush\&}{GetBrush}{\void}
 365
 366 \constfunc{const wxBrush\&}{GetBrush}{\void}
 367
 368 Gets the current brush (see \helpref{wxSVGFileDC::SetBrush}{wxdcsetbrush}).
 369
 370 \membersection{wxSVGFileDC::GetCharHeight}\label{wxsvgfiledcgetcharheight}
 371
 372 \func{wxCoord}{GetCharHeight}{\void}
 373
 374 Gets the character height of the currently set font.
 375
 376 \membersection{wxSVGFileDC::GetCharWidth}\label{wxsvgfiledcgetcharwidth}
 377
 378 \func{wxCoord}{GetCharWidth}{\void}
 379
 380 Gets the average character width of the currently set font.
 381
 382 \membersection{wxSVGFileDC::GetClippingBox}\label{wxsvgfiledcgetclippingbox}
 383
 384 \func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}}
 385
 386 Not implemented
 387
 388 \membersection{wxSVGFileDC::GetFont}\label{wxsvgfiledcgetfont}
 389
 390 \func{wxFont\&}{GetFont}{\void}
 391
 392 \constfunc{const wxFont\&}{GetFont}{\void}
 393
 394 Gets the current font (see \helpref{wxSVGFileDC::SetFont}{wxdcsetfont}).
 395
 396 \membersection{wxSVGFileDC::GetLogicalFunction}\label{wxsvgfiledcgetlogicalfunction}
 397
 398 \func{int}{GetLogicalFunction}{\void}
 399
 400 Gets the current logical function (see \helpref{wxSVGFileDC::SetLogicalFunction}{wxdcsetlogicalfunction}).
 401
 402 \membersection{wxSVGFileDC::GetMapMode}\label{wxsvgfiledcgetmapmode}
 403
 404 \func{int}{GetMapMode}{\void}
 405
 406 Gets the {\it mapping mode} for the device context (see \helpref{wxSVGFileDC::SetMapMode}{wxdcsetmapmode}).
 407
 408 \membersection{wxSVGFileDC::GetPen}\label{wxsvgfiledcgetpen}
 409
 410 \func{wxPen\&}{GetPen}{\void}
 411
 412 \constfunc{const wxPen\&}{GetPen}{\void}
 413
 414 Gets the current pen (see \helpref{wxSVGFileDC::SetPen}{wxdcsetpen}).
 415
 416 \membersection{wxSVGFileDC::GetPixel}\label{wxsvgfiledcgetpixel}
 417
 418 \func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}}
 419
 420 Not implemented
 421
 422 \membersection{wxSVGFileDC::GetSize}\label{wxsvgfiledcgetsize}
 423
 424 \func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
 425
 426
 427 For a Windows printer device context, this gets the horizontal and vertical
 428 resolution.
 429
 430 \membersection{wxSVGFileDC::GetTextBackground}\label{wxsvgfiledcgettextbackground}
 431
 432 \func{wxColour\&}{GetTextBackground}{\void}
 433
 434 \constfunc{const wxColour\&}{GetTextBackground}{\void}
 435
 436 Gets the current text background colour (see \helpref{wxSVGFileDC::SetTextBackground}{wxdcsettextbackground}).
 437
 438 \membersection{wxSVGFileDC::GetTextExtent}\label{wxsvgfiledcgettextextent}
 439
 440 \func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\
 441   \param{wxCoord *}{descent = NULL}, \param{wxCoord *}{externalLeading = NULL}, \param{wxFont *}{font = NULL}}
 442
 443 Gets the dimensions of the string using the currently selected font.
 444 \rtfsp{\it string} is the text string to measure, {\it w} and {\it h} are
 445 the total width and height respectively, {\it descent} is the
 446 dimension from the baseline of the font to the bottom of the
 447 descender, and {\it externalLeading} is any extra vertical space added
 448 to the font by the font designer (usually is zero).
 449
 450 The optional parameter {\it font} specifies an alternative
 451 to the currently selected font: but note that this does not
 452 yet work under Windows, so you need to set a font for
 453 the device context first.
 454
 455 See also \helpref{wxFont}{wxfont}, \helpref{wxSVGFileDC::SetFont}{wxdcsetfont}.
 456
 457 \membersection{wxSVGFileDC::GetTextForeground}\label{wxsvgfiledcgettextforeground}
 458
 459 \func{wxColour\&}{GetTextForeground}{\void}
 460
 461 \constfunc{const wxColour\&}{GetTextForeground}{\void}
 462
 463 Gets the current text foreground colour (see \helpref{wxSVGFileDC::SetTextForeground}{wxdcsettextforeground}).
 464
 465
 466 \membersection{wxSVGFileDC::GetUserScale}\label{wxsvgfiledcgetuserscale}
 467
 468 \func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}}
 469
 470 Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}).
 471
 472 \membersection{wxSVGFileDC::LogicalToDeviceX}\label{wxsvgfiledclogicaltodevicex}
 473
 474 \func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}
 475
 476 Converts logical X coordinate to device coordinate, using the current
 477 mapping mode.
 478
 479 \membersection{wxSVGFileDC::LogicalToDeviceXRel}\label{wxsvgfiledclogicaltodevicexrel}
 480
 481 \func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
 482
 483 Converts logical X coordinate to relative device coordinate, using the current
 484 mapping mode but ignoring the x axis orientation.
 485 Use this for converting a width, for example.
 486
 487 \membersection{wxSVGFileDC::LogicalToDeviceY}\label{wxsvgfiledclogicaltodevicey}
 488
 489 \func{wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}}
 490
 491 Converts logical Y coordinate to device coordinate, using the current
 492 mapping mode.
 493
 494 \membersection{wxSVGFileDC::LogicalToDeviceYRel}\label{wxsvgfiledclogicaltodeviceyrel}
 495
 496 \func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
 497
 498 Converts logical Y coordinate to relative device coordinate, using the current
 499 mapping mode but ignoring the y axis orientation.
 500 Use this for converting a height, for example.
 501
 502 \membersection{wxSVGFileDC::MaxX}\label{wxsvgfiledcmaxx}
 503
 504 \func{wxCoord}{MaxX}{\void}
 505
 506 Gets the maximum horizontal extent used in drawing commands so far.
 507
 508 \membersection{wxSVGFileDC::MaxY}\label{wxsvgfiledcmaxy}
 509
 510 \func{wxCoord}{MaxY}{\void}
 511
 512 Gets the maximum vertical extent used in drawing commands so far.
 513
 514 \membersection{wxSVGFileDC::MinX}\label{wxsvgfiledcminx}
 515
 516 \func{wxCoord}{MinX}{\void}
 517
 518 Gets the minimum horizontal extent used in drawing commands so far.
 519
 520 \membersection{wxSVGFileDC::MinY}\label{wxsvgfiledcminy}
 521
 522 \func{wxCoord}{MinY}{\void}
 523
 524 Gets the minimum vertical extent used in drawing commands so far.
 525
 526 \membersection{wxSVGFileDC::Ok}\label{wxsvgfiledcok}
 527
 528 \func{bool}{Ok}{\void}
 529
 530 Returns true if the DC is ok to use; False values arise from being unable to
 531 write the file
 532
 533 \membersection{wxSVGFileDC::ResetBoundingBox}\label{wxsvgfiledcresetboundingbox}
 534
 535 \func{void}{ResetBoundingBox}{\void}
 536
 537 Resets the bounding box: after a call to this function, the bounding box
 538 doesn't contain anything.
 539
 540 \wxheading{See also}
 541
 542 \helpref{CalcBoundingBox}{wxdccalcboundingbox}
 543
 544 \membersection{wxSVGFileDC::SetAxisOrientation}\label{wxsvgfiledcsetaxisorientation}
 545
 546 \func{void}{SetAxisOrientation}{\param{bool}{ xLeftRight},
 547                                 \param{bool}{ yBottomUp}}
 548
 549 Sets the x and y axis orientation (i.e., the direction from lowest to
 550 highest values on the axis). The default orientation is the natural
 551 orientation, e.g. x axis from left to right and y axis from bottom up.
 552
 553 \wxheading{Parameters}
 554
 555 \docparam{xLeftRight}{True to set the x axis orientation to the natural
 556 left to right orientation, false to invert it.}
 557
 558 \docparam{yBottomUp}{True to set the y axis orientation to the natural
 559 bottom up orientation, false to invert it.}
 560
 561 \membersection{wxSVGFileDC::SetDeviceOrigin}\label{wxsvgfiledcsetdeviceorigin}
 562
 563 \func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
 564
 565 Sets the device origin (i.e., the origin in pixels after scaling has been
 566 applied).
 567
 568 This function may be useful in Windows printing
 569 operations for placing a graphic on a page.
 570
 571 \membersection{wxSVGFileDC::SetBackground}\label{wxsvgfiledcsetbackground}
 572
 573 \func{void}{SetBackground}{\param{const wxBrush\& }{brush}}
 574
 575 Sets the current background brush for the DC.
 576
 577 \membersection{wxSVGFileDC::SetBackgroundMode}\label{wxsvgfiledcsetbackgroundmode}
 578
 579 \func{void}{SetBackgroundMode}{\param{int}{ mode}}
 580
 581 {\it mode} may be one of wxSOLID and wxTRANSPARENT. This setting determines
 582 whether text will be drawn with a background colour or not.
 583
 584 \membersection{wxSVGFileDC::SetClippingRegion}\label{wxsvgfiledcsetclippingregion}
 585
 586 \func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
 587
 588 \func{void}{SetClippingRegion}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}
 589
 590 \func{void}{SetClippingRegion}{\param{const wxRect\&}{ rect}}
 591
 592 \func{void}{SetClippingRegion}{\param{const wxRegion\&}{ region}}
 593
 594 Not implemented
 595
 596
 597 \membersection{wxSVGFileDC::SetPalette}\label{wxsvgfiledcsetpalette}
 598
 599 \func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
 600
 601 Not implemented
 602
 603 \membersection{wxSVGFileDC::SetBrush}\label{wxsvgfiledcsetbrush}
 604
 605 \func{void}{SetBrush}{\param{const wxBrush\& }{brush}}
 606
 607 Sets the current brush for the DC.
 608
 609 If the argument is wxNullBrush, the current brush is selected out of the device
 610 context, and the original brush restored, allowing the current brush to
 611 be destroyed safely.
 612
 613 See also \helpref{wxBrush}{wxbrush}.
 614
 615 See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
 616 when drawing into a monochrome bitmap.
 617
 618 \membersection{wxSVGFileDC::SetFont}\label{wxsvgfiledcsetfont}
 619
 620 \func{void}{SetFont}{\param{const wxFont\& }{font}}
 621
 622 Sets the current font for the DC. It must be a valid font, in particular you
 623 should not pass {\tt wxNullFont} to this method.
 624
 625 See also \helpref{wxFont}{wxfont}.
 626
 627 \membersection{wxSVGFileDC::SetLogicalFunction}\label{wxsvgfiledcsetlogicalfunction}
 628
 629 \func{void}{SetLogicalFunction}{\param{int}{ function}}
 630
 631
 632 Only wxCOPY is avalaible; trying to set one of the othe values will fail
 633
 634 \membersection{wxSVGFileDC::SetMapMode}\label{wxsvgfiledcsetmapmode}
 635
 636 \func{void}{SetMapMode}{\param{int}{ int}}
 637
 638 The {\it mapping mode} of the device context defines the unit of
 639 measurement used to convert logical units to device units. Note that
 640 in X, text drawing isn't handled consistently with the mapping mode; a
 641 font is always specified in point size. However, setting the {\it
 642 user scale} (see \helpref{wxSVGFileDC::SetUserScale}{wxdcsetuserscale}) scales the text appropriately. In
 643 Windows, scaleable TrueType fonts are always used; in X, results depend
 644 on availability of fonts, but usually a reasonable match is found.
 645
 646 Note that the coordinate origin should ideally be selectable, but for
 647 now is always at the top left of the screen/printer.
 648
 649 Drawing to a Windows printer device context under UNIX
 650 uses the current mapping mode, but mapping mode is currently ignored for
 651 PostScript output.
 652
 653 The mapping mode can be one of the following:
 654
 655 \begin{twocollist}\itemsep=0pt
 656 \twocolitem{wxMM\_TWIPS}{Each logical unit is 1/20 of a point, or 1/1440 of
 657   an inch.}
 658 \twocolitem{wxMM\_POINTS}{Each logical unit is a point, or 1/72 of an inch.}
 659 \twocolitem{wxMM\_METRIC}{Each logical unit is 1 mm.}
 660 \twocolitem{wxMM\_LOMETRIC}{Each logical unit is 1/10 of a mm.}
 661 \twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.}
 662 \end{twocollist}
 663
 664 \membersection{wxSVGFileDC::SetPen}\label{wxsvgfiledcsetpen}
 665
 666 \func{void}{SetPen}{\param{const wxPen\& }{pen}}
 667
 668 Sets the current pen for the DC.
 669
 670 If the argument is wxNullPen, the current pen is selected out of the device
 671 context, and the original pen restored.
 672
 673 See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
 674 when drawing into a monochrome bitmap.
 675
 676 \membersection{wxSVGFileDC::SetTextBackground}\label{wxsvgfiledcsettextbackground}
 677
 678 \func{void}{SetTextBackground}{\param{const wxColour\& }{colour}}
 679
 680 Sets the current text background colour for the DC.
 681
 682 \membersection{wxSVGFileDC::SetTextForeground}\label{wxsvgfiledcsettextforeground}
 683
 684 \func{void}{SetTextForeground}{\param{const wxColour\& }{colour}}
 685
 686 Sets the current text foreground colour for the DC.
 687
 688 See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
 689 when drawing into a monochrome bitmap.
 690
 691 \membersection{wxSVGFileDC::SetUserScale}\label{wxsvgfiledcsetuserscale}
 692
 693 \func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}}
 694
 695 Sets the user scaling factor, useful for applications which require
 696 `zooming'.
 697
 698 \membersection{wxSVGFileDC::StartDoc}\label{wxsvgfiledcstartdoc}
 699
 700 \func{bool}{StartDoc}{\param{const wxString\& }{message}}
 701
 702 Does nothing
 703
 704 \membersection{wxSVGFileDC::StartPage}\label{wxsvgfiledcstartpage}
 705
 706 \func{bool}{StartPage}{\void}
 707
 708 Does nothing