added wxSVGFileDC docs to main chain

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48181 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2007-08-19 16:41:13 +00:00
parent ab97173392
commit 0c6fcb099e
2 changed files with 82 additions and 113 deletions

View File

@@ -96,6 +96,7 @@
\input db.tex \input db.tex
\input dc.tex \input dc.tex
\input dcclipper.tex \input dcclipper.tex
\input dcsvg.tex
\input ddeclint.tex \input ddeclint.tex
\input ddeconn.tex \input ddeconn.tex
\input ddeservr.tex \input ddeservr.tex

View File

@@ -1,38 +1,4 @@
\documentstyle[a4,makeidx,verbatim,texhelp,fancyhea,mysober,mytitle]{report}% \section{\class{wxSVGFileDC}}\label{wxsvgfiledc}
%\input{psbox.tex}
\newcommand{\commandref}[2]{\helpref{{\tt $\backslash$#1}}{#2}}%
\newcommand{\commandrefn}[2]{\helprefn{{\tt $\backslash$#1}}{#2}\index{#1}}%
\newcommand{\commandpageref}[2]{\latexignore{\helprefn{{\tt $\backslash$#1}}{#2}}\latexonly{{\tt $\backslash$#1} {\it page \pageref{#2}}}\index{#1}}%
\newcommand{\indexit}[1]{#1\index{#1}}%
\newcommand{\inioption}[1]{{\bf {\tt #1}}\index{#1}}%
\parskip=10pt%
\parindent=0pt%
%\backgroundcolour{255;255;255}\textcolour{0;0;0}% Has an effect in HTML only
\winhelpignore{\title{Manual for wxSVGFileDC}%
\author{Chris Elliott}%
\date{June 2002}%
}%
\winhelponly{\title{Manual for wxSVGFileDC}%
\author{by Chris Elliott}%
}%
\makeindex%
\begin{document}%
\maketitle%
\pagestyle{fancyplain}%
\bibliographystyle{plain}%
\pagenumbering{roman}%
\setheader{{\it CONTENTS}}{}{}{}{}{{\it CONTENTS}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
\tableofcontents%
\chapter*{Copyright notice}%
\setheader{{\it COPYRIGHT}}{}{}{}{}{{\it COPYRIGHT}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
\chapter*{wxSVGFileDC}%
\setheader{{\it wxSVGFileDC}}{}{}{}{}{{\it wxSVGFileDC}}%
\setfooter{\thepage}{}{}{}{}{\thepage}%
\section{\class{wxSVGFileDC}}\label{wxSVGFileDC}
A wxSVGFileDC is a {\it device context} onto which graphics and text can be drawn, and the output A wxSVGFileDC is a {\it device context} onto which graphics and text can be drawn, and the output
produced as a vector file, in the SVG format (see http://www.w3.org/TR/2001/REC-SVG-20010904/ ). produced as a vector file, in the SVG format (see http://www.w3.org/TR/2001/REC-SVG-20010904/ ).
@@ -53,7 +19,7 @@ http://www.xs4all.nl/~kholwerd/wxstuff/canvas/htmldocbook/aap.html
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxDCBase}{wxDCBase} \helpref{wxDC}{wxdc}
\wxheading{Include files} \wxheading{Include files}
@@ -70,28 +36,30 @@ http://www.xs4all.nl/~kholwerd/wxstuff/canvas/htmldocbook/aap.html
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxSVGFileDC::wxSVGFileDC} \membersection{wxSVGFileDC::wxSVGFileDC}\label{wxsvgfiledcctor}
\func{}{wxSVGFileDC}{\param{wxString}{ f}} \rtfsp \func{}{wxSVGFileDC}{\param{wxString}{ f}}
\func{}{wxSVGFileDC}{\param{wxString}{ f}, \param{int}{ Width},\param{int}{ Height}} \rtfsp
\func{}{wxSVGFileDC}{\param{wxString}{ f}, \param{int}{ Width},\param{int}{ Height},\param{float}{ dpi}} \rtfsp \func{}{wxSVGFileDC}{\param{wxString}{ f}, \param{int}{ Width},\param{int}{ Height}}
\func{}{wxSVGFileDC}{\param{wxString}{ f}, \param{int}{ Width},\param{int}{ Height},\param{float}{ dpi}}
Constructors: Constructors:
a filename {\it f} with default size 340x240 at 72.0 dots per inch (a frequent screen resolution). a filename {\it f} with default size 340x240 at 72.0 dots per inch (a frequent screen resolution).
a filename {\it f} with size {\it Width} by {\it Height} at 72.0 dots per inch a filename {\it f} with size {\it Width} by {\it Height} at 72.0 dots per inch
a filename {\it f} with size {\it Width} by {\it Height} at {\it dpi} resolution. a filename {\it f} with size {\it Width} by {\it Height} at {\it dpi} resolution.
\membersection{wxSVGFileDC::\destruct{wxSVGFileDC}} \membersection{wxSVGFileDC::\destruct{wxSVGFileDC}}\label{wxsvgfiledcdtor}
\func{}{\destruct{wxSVGFileDC}}{\void} \func{}{\destruct{wxSVGFileDC}}{\void}
Destructor. Destructor.
\membersection{wxSVGFileDC::BeginDrawing}\label{wxdcbegindrawing} \membersection{wxSVGFileDC::BeginDrawing}\label{wxsvgfiledcbegindrawing}
Does nothing Does nothing
\membersection{wxSVGFileDC::Blit}\label{wxdcblit} \membersection{wxSVGFileDC::Blit}\label{wxsvgfiledcblit}
\func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
\param{wxSVGFileDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY}, \param{wxSVGFileDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY},
@@ -101,7 +69,7 @@ As wxDC: Copy from a source DC to this DC, specifying the destination
coordinates, size of area to copy, source DC, source coordinates, coordinates, size of area to copy, source DC, source coordinates,
logical function, whether to use a bitmap mask, and mask source position. logical function, whether to use a bitmap mask, and mask source position.
\membersection{wxSVGFileDC::CalcBoundingBox}\label{wxdccalcboundingbox} \membersection{wxSVGFileDC::CalcBoundingBox}\label{wxsvgfiledccalcboundingbox}
\func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}} \func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}}
@@ -110,33 +78,33 @@ Adds the specified point to the bounding box which can be retrieved with
\helpref{MinY}{wxdcminy}, \helpref{MaxY}{wxdcmaxy} functions. \helpref{MinY}{wxdcminy}, \helpref{MaxY}{wxdcmaxy} functions.
\membersection{wxSVGFileDC::Clear}\label{wxdcclear} \membersection{wxSVGFileDC::Clear}\label{wxsvgfiledcclear}
\func{void}{Clear}{\void} \func{void}{Clear}{\void}
This makes no sense in wxSVGFileDC and does nothing This makes no sense in wxSVGFileDC and does nothing
\membersection{wxSVGFileDC::CrossHair}\label{wxdccrosshair} \membersection{wxSVGFileDC::CrossHair}\label{wxsvgfiledccrosshair}
\func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} \func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
Not Implemented Not Implemented
\membersection{wxSVGFileDC::DestroyClippingRegion}\label{wxdcdestroyclippingregion} \membersection{wxSVGFileDC::DestroyClippingRegion}\label{wxsvgfiledcdestroyclippingregion}
\func{void}{DestroyClippingRegion}{\void} \func{void}{DestroyClippingRegion}{\void}
Not Implemented Not Implemented
\membersection{wxSVGFileDC::DeviceToLogicalX}\label{wxdcdevicetologicalx} \membersection{wxSVGFileDC::DeviceToLogicalX}\label{wxsvgfiledcdevicetologicalx}
\func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}} \func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}
Convert device X coordinate to logical coordinate, using the current Convert device X coordinate to logical coordinate, using the current
mapping mode. mapping mode.
\membersection{wxSVGFileDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel} \membersection{wxSVGFileDC::DeviceToLogicalXRel}\label{wxsvgfiledcdevicetologicalxrel}
\func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}} \func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
@@ -144,14 +112,14 @@ Convert device X coordinate to relative logical coordinate, using the current
mapping mode but ignoring the x axis orientation. mapping mode but ignoring the x axis orientation.
Use this function for converting a width, for example. Use this function for converting a width, for example.
\membersection{wxSVGFileDC::DeviceToLogicalY}\label{wxdcdevicetologicaly} \membersection{wxSVGFileDC::DeviceToLogicalY}\label{wxsvgfiledcdevicetologicaly}
\func{wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}} \func{wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}}
Converts device Y coordinate to logical coordinate, using the current Converts device Y coordinate to logical coordinate, using the current
mapping mode. mapping mode.
\membersection{wxSVGFileDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel} \membersection{wxSVGFileDC::DeviceToLogicalYRel}\label{wxsvgfiledcdevicetologicalyrel}
\func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}} \func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
@@ -159,7 +127,7 @@ Convert device Y coordinate to relative logical coordinate, using the current
mapping mode but ignoring the y axis orientation. mapping mode but ignoring the y axis orientation.
Use this function for converting a height, for example. Use this function for converting a height, for example.
\membersection{wxSVGFileDC::DrawArc}\label{wxdcdrawarc} \membersection{wxSVGFileDC::DrawArc}\label{wxsvgfiledcdrawarc}
\func{void}{DrawArc}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ xc}, \param{wxCoord}{ yc}} \func{void}{DrawArc}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ xc}, \param{wxCoord}{ yc}}
@@ -169,7 +137,7 @@ and the current brush for filling the shape.
The arc is drawn in an anticlockwise direction from the start point to the end point. The arc is drawn in an anticlockwise direction from the start point to the end point.
\membersection{wxSVGFileDC::DrawBitmap}\label{wxdcdrawbitmap} \membersection{wxSVGFileDC::DrawBitmap}\label{wxsvgfiledcdrawbitmap}
\func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}} \func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}}
@@ -181,7 +149,7 @@ of the bitmap (all bits set to 1), and the current text background colour to dra
(all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground}, (all bits set to 0). See also \helpref{SetTextForeground}{wxdcsettextforeground},
\helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}. \helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
\membersection{wxSVGFileDC::DrawCheckMark}\label{wxdcdrawcheckmark} \membersection{wxSVGFileDC::DrawCheckMark}\label{wxsvgfiledcdrawcheckmark}
\func{void}{DrawCheckMark}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}} \func{void}{DrawCheckMark}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
@@ -189,7 +157,7 @@ of the bitmap (all bits set to 1), and the current text background colour to dra
Draws a check mark inside the given rectangle. Draws a check mark inside the given rectangle.
\membersection{wxSVGFileDC::DrawCircle}\label{wxdcdrawcircle} \membersection{wxSVGFileDC::DrawCircle}\label{wxsvgfiledcdrawcircle}
\func{void}{DrawCircle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ radius}} \func{void}{DrawCircle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ radius}}
@@ -201,7 +169,7 @@ Draws a circle with the given centre and radius.
\helpref{DrawEllipse}{wxdcdrawellipse} \helpref{DrawEllipse}{wxdcdrawellipse}
\membersection{wxSVGFileDC::DrawEllipse}\label{wxdcdrawellipse} \membersection{wxSVGFileDC::DrawEllipse}\label{wxsvgfiledcdrawellipse}
\func{void}{DrawEllipse}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}} \func{void}{DrawEllipse}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
@@ -217,7 +185,7 @@ outline and the current brush for filling the shape.
\helpref{DrawCircle}{wxdcdrawcircle} \helpref{DrawCircle}{wxdcdrawcircle}
\membersection{wxSVGFileDC::DrawEllipticArc}\label{wxdcdrawellipticarc} \membersection{wxSVGFileDC::DrawEllipticArc}\label{wxsvgfiledcdrawellipticarc}
\func{void}{DrawEllipticArc}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \func{void}{DrawEllipticArc}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
\param{double}{ start}, \param{double}{ end}} \param{double}{ start}, \param{double}{ end}}
@@ -237,21 +205,21 @@ in degrees (360 is a complete circle). Positive values mean
counter-clockwise motion. If {\it start} is equal to {\it end}, a counter-clockwise motion. If {\it start} is equal to {\it end}, a
complete ellipse will be drawn. complete ellipse will be drawn.
\membersection{wxSVGFileDC::DrawIcon}\label{wxdcdrawicon} \membersection{wxSVGFileDC::DrawIcon}\label{wxsvgfiledcdrawicon}
\func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{wxCoord}{ x}, \param{wxCoord}{ y}} \func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
Draw an icon on the display (does nothing if the device context is PostScript). Draw an icon on the display (does nothing if the device context is PostScript).
This can be the simplest way of drawing bitmaps on a window. This can be the simplest way of drawing bitmaps on a window.
\membersection{wxSVGFileDC::DrawLine}\label{wxdcdrawline} \membersection{wxSVGFileDC::DrawLine}\label{wxsvgfiledcdrawline}
\func{void}{DrawLine}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}} \func{void}{DrawLine}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}}
Draws a line from the first point to the second. The current pen is used Draws a line from the first point to the second. The current pen is used
for drawing the line. for drawing the line.
\membersection{wxSVGFileDC::DrawLines}\label{wxdcdrawlines} \membersection{wxSVGFileDC::DrawLines}\label{wxsvgfiledcdrawlines}
\func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}} \func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
@@ -262,7 +230,7 @@ pointers to points, adding the optional offset coordinate. The current
pen is used for drawing the lines. The programmer is responsible for pen is used for drawing the lines. The programmer is responsible for
deleting the list of points. deleting the list of points.
\membersection{wxSVGFileDC::DrawPolygon}\label{wxdcdrawpolygon} \membersection{wxSVGFileDC::DrawPolygon}\label{wxsvgfiledcdrawpolygon}
\func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\ \func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
\param{int }{fill\_style = wxODDEVEN\_RULE}} \param{int }{fill\_style = wxODDEVEN\_RULE}}
@@ -283,13 +251,13 @@ The programmer is responsible for deleting the list of points.
Note that wxWindows automatically closes the first and last points. Note that wxWindows automatically closes the first and last points.
\membersection{wxSVGFileDC::DrawPoint}\label{wxdcdrawpoint} \membersection{wxSVGFileDC::DrawPoint}\label{wxsvgfiledcdrawpoint}
\func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} \func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
Draws a point using the current pen. Draws a point using the current pen.
\membersection{wxSVGFileDC::DrawRectangle}\label{wxdcdrawrectangle} \membersection{wxSVGFileDC::DrawRectangle}\label{wxsvgfiledcdrawrectangle}
\func{void}{DrawRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}} \func{void}{DrawRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
@@ -297,7 +265,7 @@ Draws a rectangle with the given top left corner, and with the given
size. The current pen is used for the outline and the current brush size. The current pen is used for the outline and the current brush
for filling the shape. for filling the shape.
\membersection{wxSVGFileDC::DrawRotatedText}\label{wxdcdrawrotatedtext} \membersection{wxSVGFileDC::DrawRotatedText}\label{wxsvgfiledcdrawrotatedtext}
\func{void}{DrawRotatedText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{double}{ angle}} \func{void}{DrawRotatedText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{double}{ angle}}
@@ -305,7 +273,7 @@ Draws the text rotated by {\it angle} degrees.
The wxMSW wxDC and wxSVGFileDC rotate the text around slightly different points, depending on the size of the font The wxMSW wxDC and wxSVGFileDC rotate the text around slightly different points, depending on the size of the font
\membersection{wxSVGFileDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle} \membersection{wxSVGFileDC::DrawRoundedRectangle}\label{wxsvgfiledcdrawroundedrectangle}
\func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius = 20}} \func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius = 20}}
@@ -322,7 +290,7 @@ a sensible size relative to the size of the rectangle, and also avoids
the strange effects X produces when the corners are too big for the strange effects X produces when the corners are too big for
the rectangle. the rectangle.
\membersection{wxSVGFileDC::DrawSpline}\label{wxdcdrawspline} \membersection{wxSVGFileDC::DrawSpline}\label{wxsvgfiledcdrawspline}
\func{void}{DrawSpline}{\param{wxList *}{points}} \func{void}{DrawSpline}{\param{wxList *}{points}}
@@ -335,7 +303,7 @@ program `XFIG'.
Draws a three-point spline using the current pen. Draws a three-point spline using the current pen.
\membersection{wxSVGFileDC::DrawText}\label{wxdcdrawtext} \membersection{wxSVGFileDC::DrawText}\label{wxsvgfiledcdrawtext}
\func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}} \func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
@@ -349,31 +317,31 @@ text more precisely.
\membersection{wxSVGFileDC::EndDoc}\label{wxdcenddoc} \membersection{wxSVGFileDC::EndDoc}\label{wxsvgfiledcenddoc}
\func{void}{EndDoc}{\void} \func{void}{EndDoc}{\void}
Does nothing Does nothing
\membersection{wxSVGFileDC::EndDrawing}\label{wxdcenddrawing} \membersection{wxSVGFileDC::EndDrawing}\label{wxsvgfiledcenddrawing}
\func{void}{EndDrawing}{\void} \func{void}{EndDrawing}{\void}
Does nothing Does nothing
\membersection{wxSVGFileDC::EndPage}\label{wxdcendpage} \membersection{wxSVGFileDC::EndPage}\label{wxsvgfiledcendpage}
\func{void}{EndPage}{\void} \func{void}{EndPage}{\void}
Does nothing Does nothing
\membersection{wxSVGFileDC::FloodFill}\label{wxdcfloodfill} \membersection{wxSVGFileDC::FloodFill}\label{wxsvgfiledcfloodfill}
\func{void}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}} \func{void}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}}
Not implemented Not implemented
\membersection{wxSVGFileDC::GetBackground}\label{wxdcgetbackground} \membersection{wxSVGFileDC::GetBackground}\label{wxsvgfiledcgetbackground}
\func{wxBrush\&}{GetBackground}{\void} \func{wxBrush\&}{GetBackground}{\void}
@@ -381,7 +349,7 @@ Not implemented
Gets the brush used for painting the background (see \helpref{wxSVGFileDC::SetBackground}{wxdcsetbackground}). Gets the brush used for painting the background (see \helpref{wxSVGFileDC::SetBackground}{wxdcsetbackground}).
\membersection{wxSVGFileDC::GetBackgroundMode}\label{wxdcgetbackgroundmode} \membersection{wxSVGFileDC::GetBackgroundMode}\label{wxsvgfiledcgetbackgroundmode}
\constfunc{int}{GetBackgroundMode}{\void} \constfunc{int}{GetBackgroundMode}{\void}
@@ -391,7 +359,7 @@ Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
\helpref{SetBackgroundMode}{wxdcsetbackgroundmode} \helpref{SetBackgroundMode}{wxdcsetbackgroundmode}
\membersection{wxSVGFileDC::GetBrush}\label{wxdcgetbrush} \membersection{wxSVGFileDC::GetBrush}\label{wxsvgfiledcgetbrush}
\func{wxBrush\&}{GetBrush}{\void} \func{wxBrush\&}{GetBrush}{\void}
@@ -399,25 +367,25 @@ Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
Gets the current brush (see \helpref{wxSVGFileDC::SetBrush}{wxdcsetbrush}). Gets the current brush (see \helpref{wxSVGFileDC::SetBrush}{wxdcsetbrush}).
\membersection{wxSVGFileDC::GetCharHeight}\label{wxdcgetcharheight} \membersection{wxSVGFileDC::GetCharHeight}\label{wxsvgfiledcgetcharheight}
\func{wxCoord}{GetCharHeight}{\void} \func{wxCoord}{GetCharHeight}{\void}
Gets the character height of the currently set font. Gets the character height of the currently set font.
\membersection{wxSVGFileDC::GetCharWidth}\label{wxdcgetcharwidth} \membersection{wxSVGFileDC::GetCharWidth}\label{wxsvgfiledcgetcharwidth}
\func{wxCoord}{GetCharWidth}{\void} \func{wxCoord}{GetCharWidth}{\void}
Gets the average character width of the currently set font. Gets the average character width of the currently set font.
\membersection{wxSVGFileDC::GetClippingBox}\label{wxdcgetclippingbox} \membersection{wxSVGFileDC::GetClippingBox}\label{wxsvgfiledcgetclippingbox}
\func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}} \func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}}
Not implemented Not implemented
\membersection{wxSVGFileDC::GetFont}\label{wxdcgetfont} \membersection{wxSVGFileDC::GetFont}\label{wxsvgfiledcgetfont}
\func{wxFont\&}{GetFont}{\void} \func{wxFont\&}{GetFont}{\void}
@@ -425,19 +393,19 @@ Not implemented
Gets the current font (see \helpref{wxSVGFileDC::SetFont}{wxdcsetfont}). Gets the current font (see \helpref{wxSVGFileDC::SetFont}{wxdcsetfont}).
\membersection{wxSVGFileDC::GetLogicalFunction}\label{wxdcgetlogicalfunction} \membersection{wxSVGFileDC::GetLogicalFunction}\label{wxsvgfiledcgetlogicalfunction}
\func{int}{GetLogicalFunction}{\void} \func{int}{GetLogicalFunction}{\void}
Gets the current logical function (see \helpref{wxSVGFileDC::SetLogicalFunction}{wxdcsetlogicalfunction}). Gets the current logical function (see \helpref{wxSVGFileDC::SetLogicalFunction}{wxdcsetlogicalfunction}).
\membersection{wxSVGFileDC::GetMapMode}\label{wxdcgetmapmode} \membersection{wxSVGFileDC::GetMapMode}\label{wxsvgfiledcgetmapmode}
\func{int}{GetMapMode}{\void} \func{int}{GetMapMode}{\void}
Gets the {\it mapping mode} for the device context (see \helpref{wxSVGFileDC::SetMapMode}{wxdcsetmapmode}). Gets the {\it mapping mode} for the device context (see \helpref{wxSVGFileDC::SetMapMode}{wxdcsetmapmode}).
\membersection{wxSVGFileDC::GetPen}\label{wxdcgetpen} \membersection{wxSVGFileDC::GetPen}\label{wxsvgfiledcgetpen}
\func{wxPen\&}{GetPen}{\void} \func{wxPen\&}{GetPen}{\void}
@@ -445,13 +413,13 @@ Gets the {\it mapping mode} for the device context (see \helpref{wxSVGFileDC::Se
Gets the current pen (see \helpref{wxSVGFileDC::SetPen}{wxdcsetpen}). Gets the current pen (see \helpref{wxSVGFileDC::SetPen}{wxdcsetpen}).
\membersection{wxSVGFileDC::GetPixel}\label{wxdcgetpixel} \membersection{wxSVGFileDC::GetPixel}\label{wxsvgfiledcgetpixel}
\func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}} \func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}}
Not implemented Not implemented
\membersection{wxSVGFileDC::GetSize}\label{wxdcgetsize} \membersection{wxSVGFileDC::GetSize}\label{wxsvgfiledcgetsize}
\func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}} \func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
@@ -459,7 +427,7 @@ Not implemented
For a Windows printer device context, this gets the horizontal and vertical For a Windows printer device context, this gets the horizontal and vertical
resolution. resolution.
\membersection{wxSVGFileDC::GetTextBackground}\label{wxdcgettextbackground} \membersection{wxSVGFileDC::GetTextBackground}\label{wxsvgfiledcgettextbackground}
\func{wxColour\&}{GetTextBackground}{\void} \func{wxColour\&}{GetTextBackground}{\void}
@@ -467,7 +435,7 @@ resolution.
Gets the current text background colour (see \helpref{wxSVGFileDC::SetTextBackground}{wxdcsettextbackground}). Gets the current text background colour (see \helpref{wxSVGFileDC::SetTextBackground}{wxdcsettextbackground}).
\membersection{wxSVGFileDC::GetTextExtent}\label{wxdcgettextextent} \membersection{wxSVGFileDC::GetTextExtent}\label{wxsvgfiledcgettextextent}
\func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\ \func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{wxCoord *}{w}, \param{wxCoord *}{h},\\
\param{wxCoord *}{descent = NULL}, \param{wxCoord *}{externalLeading = NULL}, \param{wxFont *}{font = NULL}} \param{wxCoord *}{descent = NULL}, \param{wxCoord *}{externalLeading = NULL}, \param{wxFont *}{font = NULL}}
@@ -486,7 +454,7 @@ the device context first.
See also \helpref{wxFont}{wxfont}, \helpref{wxSVGFileDC::SetFont}{wxdcsetfont}. See also \helpref{wxFont}{wxfont}, \helpref{wxSVGFileDC::SetFont}{wxdcsetfont}.
\membersection{wxSVGFileDC::GetTextForeground}\label{wxdcgettextforeground} \membersection{wxSVGFileDC::GetTextForeground}\label{wxsvgfiledcgettextforeground}
\func{wxColour\&}{GetTextForeground}{\void} \func{wxColour\&}{GetTextForeground}{\void}
@@ -495,20 +463,20 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxSVGFileDC::SetFont}{wxdcsetfont}.
Gets the current text foreground colour (see \helpref{wxSVGFileDC::SetTextForeground}{wxdcsettextforeground}). Gets the current text foreground colour (see \helpref{wxSVGFileDC::SetTextForeground}{wxdcsettextforeground}).
\membersection{wxSVGFileDC::GetUserScale}\label{wxdcgetuserscale} \membersection{wxSVGFileDC::GetUserScale}\label{wxsvgfiledcgetuserscale}
\func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}} \func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}}
Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}). Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}).
\membersection{wxSVGFileDC::LogicalToDeviceX}\label{wxdclogicaltodevicex} \membersection{wxSVGFileDC::LogicalToDeviceX}\label{wxsvgfiledclogicaltodevicex}
\func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}} \func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}
Converts logical X coordinate to device coordinate, using the current Converts logical X coordinate to device coordinate, using the current
mapping mode. mapping mode.
\membersection{wxSVGFileDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel} \membersection{wxSVGFileDC::LogicalToDeviceXRel}\label{wxsvgfiledclogicaltodevicexrel}
\func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}} \func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
@@ -516,14 +484,14 @@ Converts logical X coordinate to relative device coordinate, using the current
mapping mode but ignoring the x axis orientation. mapping mode but ignoring the x axis orientation.
Use this for converting a width, for example. Use this for converting a width, for example.
\membersection{wxSVGFileDC::LogicalToDeviceY}\label{wxdclogicaltodevicey} \membersection{wxSVGFileDC::LogicalToDeviceY}\label{wxsvgfiledclogicaltodevicey}
\func{wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}} \func{wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}}
Converts logical Y coordinate to device coordinate, using the current Converts logical Y coordinate to device coordinate, using the current
mapping mode. mapping mode.
\membersection{wxSVGFileDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel} \membersection{wxSVGFileDC::LogicalToDeviceYRel}\label{wxsvgfiledclogicaltodeviceyrel}
\func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}} \func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
@@ -531,38 +499,38 @@ Converts logical Y coordinate to relative device coordinate, using the current
mapping mode but ignoring the y axis orientation. mapping mode but ignoring the y axis orientation.
Use this for converting a height, for example. Use this for converting a height, for example.
\membersection{wxSVGFileDC::MaxX}\label{wxdcmaxx} \membersection{wxSVGFileDC::MaxX}\label{wxsvgfiledcmaxx}
\func{wxCoord}{MaxX}{\void} \func{wxCoord}{MaxX}{\void}
Gets the maximum horizontal extent used in drawing commands so far. Gets the maximum horizontal extent used in drawing commands so far.
\membersection{wxSVGFileDC::MaxY}\label{wxdcmaxy} \membersection{wxSVGFileDC::MaxY}\label{wxsvgfiledcmaxy}
\func{wxCoord}{MaxY}{\void} \func{wxCoord}{MaxY}{\void}
Gets the maximum vertical extent used in drawing commands so far. Gets the maximum vertical extent used in drawing commands so far.
\membersection{wxSVGFileDC::MinX}\label{wxdcminx} \membersection{wxSVGFileDC::MinX}\label{wxsvgfiledcminx}
\func{wxCoord}{MinX}{\void} \func{wxCoord}{MinX}{\void}
Gets the minimum horizontal extent used in drawing commands so far. Gets the minimum horizontal extent used in drawing commands so far.
\membersection{wxSVGFileDC::MinY}\label{wxdcminy} \membersection{wxSVGFileDC::MinY}\label{wxsvgfiledcminy}
\func{wxCoord}{MinY}{\void} \func{wxCoord}{MinY}{\void}
Gets the minimum vertical extent used in drawing commands so far. Gets the minimum vertical extent used in drawing commands so far.
\membersection{wxSVGFileDC::Ok}\label{wxdcok} \membersection{wxSVGFileDC::Ok}\label{wxsvgfiledcok}
\func{bool}{Ok}{\void} \func{bool}{Ok}{\void}
Returns true if the DC is ok to use; False values arise from being unable to Returns true if the DC is ok to use; False values arise from being unable to
write the file write the file
\membersection{wxSVGFileDC::ResetBoundingBox}\label{wxdcresetboundingbox} \membersection{wxSVGFileDC::ResetBoundingBox}\label{wxsvgfiledcresetboundingbox}
\func{void}{ResetBoundingBox}{\void} \func{void}{ResetBoundingBox}{\void}
@@ -573,7 +541,7 @@ doesn't contain anything.
\helpref{CalcBoundingBox}{wxdccalcboundingbox} \helpref{CalcBoundingBox}{wxdccalcboundingbox}
\membersection{wxSVGFileDC::SetAxisOrientation}\label{wxdcsetaxisorientation} \membersection{wxSVGFileDC::SetAxisOrientation}\label{wxsvgfiledcsetaxisorientation}
\func{void}{SetAxisOrientation}{\param{bool}{ xLeftRight}, \func{void}{SetAxisOrientation}{\param{bool}{ xLeftRight},
\param{bool}{ yBottomUp}} \param{bool}{ yBottomUp}}
@@ -590,7 +558,7 @@ left to right orientation, false to invert it.}
\docparam{yBottomUp}{True to set the y axis orientation to the natural \docparam{yBottomUp}{True to set the y axis orientation to the natural
bottom up orientation, false to invert it.} bottom up orientation, false to invert it.}
\membersection{wxSVGFileDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin} \membersection{wxSVGFileDC::SetDeviceOrigin}\label{wxsvgfiledcsetdeviceorigin}
\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}} \func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
@@ -600,20 +568,20 @@ applied).
This function may be useful in Windows printing This function may be useful in Windows printing
operations for placing a graphic on a page. operations for placing a graphic on a page.
\membersection{wxSVGFileDC::SetBackground}\label{wxdcsetbackground} \membersection{wxSVGFileDC::SetBackground}\label{wxsvgfiledcsetbackground}
\func{void}{SetBackground}{\param{const wxBrush\& }{brush}} \func{void}{SetBackground}{\param{const wxBrush\& }{brush}}
Sets the current background brush for the DC. Sets the current background brush for the DC.
\membersection{wxSVGFileDC::SetBackgroundMode}\label{wxdcsetbackgroundmode} \membersection{wxSVGFileDC::SetBackgroundMode}\label{wxsvgfiledcsetbackgroundmode}
\func{void}{SetBackgroundMode}{\param{int}{ mode}} \func{void}{SetBackgroundMode}{\param{int}{ mode}}
{\it mode} may be one of wxSOLID and wxTRANSPARENT. This setting determines {\it mode} may be one of wxSOLID and wxTRANSPARENT. This setting determines
whether text will be drawn with a background colour or not. whether text will be drawn with a background colour or not.
\membersection{wxSVGFileDC::SetClippingRegion}\label{wxdcsetclippingregion} \membersection{wxSVGFileDC::SetClippingRegion}\label{wxsvgfiledcsetclippingregion}
\func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}} \func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
@@ -626,13 +594,13 @@ whether text will be drawn with a background colour or not.
Not implemented Not implemented
\membersection{wxSVGFileDC::SetPalette}\label{wxdcsetpalette} \membersection{wxSVGFileDC::SetPalette}\label{wxsvgfiledcsetpalette}
\func{void}{SetPalette}{\param{const wxPalette\& }{palette}} \func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
Not implemented Not implemented
\membersection{wxSVGFileDC::SetBrush}\label{wxdcsetbrush} \membersection{wxSVGFileDC::SetBrush}\label{wxsvgfiledcsetbrush}
\func{void}{SetBrush}{\param{const wxBrush\& }{brush}} \func{void}{SetBrush}{\param{const wxBrush\& }{brush}}
@@ -647,7 +615,7 @@ See also \helpref{wxBrush}{wxbrush}.
See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
when drawing into a monochrome bitmap. when drawing into a monochrome bitmap.
\membersection{wxSVGFileDC::SetFont}\label{wxdcsetfont} \membersection{wxSVGFileDC::SetFont}\label{wxsvgfiledcsetfont}
\func{void}{SetFont}{\param{const wxFont\& }{font}} \func{void}{SetFont}{\param{const wxFont\& }{font}}
@@ -656,14 +624,14 @@ should not pass {\tt wxNullFont} to this method.
See also \helpref{wxFont}{wxfont}. See also \helpref{wxFont}{wxfont}.
\membersection{wxSVGFileDC::SetLogicalFunction}\label{wxdcsetlogicalfunction} \membersection{wxSVGFileDC::SetLogicalFunction}\label{wxsvgfiledcsetlogicalfunction}
\func{void}{SetLogicalFunction}{\param{int}{ function}} \func{void}{SetLogicalFunction}{\param{int}{ function}}
Only wxCOPY is avalaible; trying to set one of the othe values will fail Only wxCOPY is avalaible; trying to set one of the othe values will fail
\membersection{wxSVGFileDC::SetMapMode}\label{wxdcsetmapmode} \membersection{wxSVGFileDC::SetMapMode}\label{wxsvgfiledcsetmapmode}
\func{void}{SetMapMode}{\param{int}{ int}} \func{void}{SetMapMode}{\param{int}{ int}}
@@ -693,7 +661,7 @@ The mapping mode can be one of the following:
\twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.} \twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.}
\end{twocollist} \end{twocollist}
\membersection{wxSVGFileDC::SetPen}\label{wxdcsetpen} \membersection{wxSVGFileDC::SetPen}\label{wxsvgfiledcsetpen}
\func{void}{SetPen}{\param{const wxPen\& }{pen}} \func{void}{SetPen}{\param{const wxPen\& }{pen}}
@@ -705,13 +673,13 @@ context, and the original pen restored.
See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
when drawing into a monochrome bitmap. when drawing into a monochrome bitmap.
\membersection{wxSVGFileDC::SetTextBackground}\label{wxdcsettextbackground} \membersection{wxSVGFileDC::SetTextBackground}\label{wxsvgfiledcsettextbackground}
\func{void}{SetTextBackground}{\param{const wxColour\& }{colour}} \func{void}{SetTextBackground}{\param{const wxColour\& }{colour}}
Sets the current text background colour for the DC. Sets the current text background colour for the DC.
\membersection{wxSVGFileDC::SetTextForeground}\label{wxdcsettextforeground} \membersection{wxSVGFileDC::SetTextForeground}\label{wxsvgfiledcsettextforeground}
\func{void}{SetTextForeground}{\param{const wxColour\& }{colour}} \func{void}{SetTextForeground}{\param{const wxColour\& }{colour}}
@@ -720,20 +688,20 @@ Sets the current text foreground colour for the DC.
See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
when drawing into a monochrome bitmap. when drawing into a monochrome bitmap.
\membersection{wxSVGFileDC::SetUserScale}\label{wxdcsetuserscale} \membersection{wxSVGFileDC::SetUserScale}\label{wxsvgfiledcsetuserscale}
\func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}} \func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}}
Sets the user scaling factor, useful for applications which require Sets the user scaling factor, useful for applications which require
`zooming'. `zooming'.
\membersection{wxSVGFileDC::StartDoc}\label{wxdcstartdoc} \membersection{wxSVGFileDC::StartDoc}\label{wxsvgfiledcstartdoc}
\func{bool}{StartDoc}{\param{const wxString\& }{message}} \func{bool}{StartDoc}{\param{const wxString\& }{message}}
Does nothing Does nothing
\membersection{wxSVGFileDC::StartPage}\label{wxdcstartpage} \membersection{wxSVGFileDC::StartPage}\label{wxsvgfiledcstartpage}
\func{bool}{StartPage}{\void} \func{bool}{StartPage}{\void}