]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/dcsvg.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
mac paths updated
[wxWidgets.git] / interface / dcsvg.h
diff --git a/interface/dcsvg.h b/interface/dcsvg.h
index ecdd743dd97d21af06da3643d9edb8dbff8c4b68..bae993d5a35338513a9c9c4ea8d9f7b1965aa760 100644 (file)
--- a/interface/dcsvg.h
+++ b/interface/dcsvg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dcsvg.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dcsvg.h
-// Purpose:     documentation for wxSVGFileDC class
+// Purpose:     interface of wxSVGFileDC
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,94 +9,87 @@
 /**
     @class wxSVGFileDC
     @wxheader{dcsvg.h}
 /**
     @class wxSVGFileDC
     @wxheader{dcsvg.h}
-    
-    A wxSVGFileDC is a @e device context onto which graphics and text can be drawn,
-    and the output
-    produced as a vector file, in the SVG format 
-    (see W3C specifications).
-    This format can be read by a range of programs, including a Netscape plugin
-    (Adobe), full details 
-    in the SVG Implementation and Resource Directory.
-    Vector formats may often be smaller than raster formats.
-    
+
+    A wxSVGFileDC is a device context onto which graphics and text can be
+    drawn, and the output produced as a vector file, in SVG format (see the W3C
+    SVG Specifications <http://www.w3.org/TR/2001/REC-SVG-20010904/>). This
+    format can be read by a range of programs, including a Netscape plugin
+    (Adobe), full details are given in the SVG Implementation and Resource
+    Directory <http://www.svgi.org/>. Vector formats may often be smaller than
+    raster formats.
+
     The intention behind wxSVGFileDC is that it can be used to produce a file
     The intention behind wxSVGFileDC is that it can be used to produce a file
-    corresponding 
-    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.
-    
-    As the wxSVGFileDC is a vector format, raster operations like GetPixel are
-    unlikely to be supported.
-    However, the SVG specification allows for PNG format raster files to be
-    embedded in the SVG, and so 
-    bitmaps, icons and blit operations into the wxSVGFileDC are supported.
-    
-    A more substantial SVG library (for reading and writing) is available at the
-    wxArt2D website.
-    
+    corresponding 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.
+
+    As the wxSVGFileDC is a vector format, raster operations like GetPixel()
+    are unlikely to be supported. However, the SVG specification allows for PNG
+    format raster files to be embedded in the SVG, and so bitmaps, icons and
+    blit operations in wxSVGFileDC are supported.
+
+    A more substantial SVG library (for reading and writing) is available at
+    the wxArt2D website <http://wxart2d.sourceforge.net/>.
+
     @library{wxcore}
     @library{wxcore}
-    @category{FIXME}
-    
-    @seealso
-    @b Members
+    @category{dc}
 */
 class wxSVGFileDC : public wxDC
 {
 public:
 */
 class wxSVGFileDC : public wxDC
 {
 public:
-    //@{
     /**
     /**
-        Constructors: 
-        a filename @e f with default size 340x240 at 72.0 dots per inch (a frequent
-        screen resolution).
-        a filename @e f with size @e Width by @e Height at 72.0 dots per inch 
-        a filename @e f with size @e Width by @e Height at @e dpi resolution.
+        Initializes a wxSVGFileDC with the given @a f filename with a default
+        size (340x240) at 72.0 dots per inch (a frequent screen resolution).
     */
     wxSVGFileDC(wxString f);
     */
     wxSVGFileDC(wxString f);
-        wxSVGFileDC(wxString f, int Width, int Height);
-        wxSVGFileDC(wxString f, int Width, int Height, float dpi);
-    //@}
-
     /**
     /**
-        Destructor.
+        Initializes a wxSVGFileDC with the given @a f filename with the given
+        @a Width and @a Height at 72.0 dots per inch.
     */
     */
-    ~wxSVGFileDC();
-
+    wxSVGFileDC(wxString f, int Width, int Height);
     /**
     /**
-        Does nothing
+        Initializes a wxSVGFileDC with the given @a f filename with the given
+        @a Width and @a Height at @a dpi resolution.
     */
     */
+    wxSVGFileDC(wxString f, int Width, int Height, float dpi);
 
 
+    /**
+        Destructor.
+    */
+    ~wxSVGFileDC();
 
     /**
 
     /**
-        As wxDC: Copy from a source DC to this DC, specifying the destination
+        Copies 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.
+
+        @see wxDC::Blit()
     */
     */
-    bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width,
-              wxCoord height, wxSVGFileDC* source,
-              wxCoord xsrc, wxCoord ysrc,
-              int logicalFunc = wxCOPY,
-              bool useMask = FALSE,
-              wxCoord xsrcMask = -1,
-              wxCoord ysrcMask = -1);
+    bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
+              wxSVGFileDC* source, wxCoord xsrc, wxCoord ysrc,
+              int logicalFunc = wxCOPY, bool useMask = FALSE,
+              wxCoord xsrcMask = -1, wxCoord ysrcMask = -1);
 
     /**
 
     /**
-        Adds the specified point to the bounding box which can be retrieved with 
-        wxDC::MinX, wxDC::MaxX and 
-        wxDC::MinY, wxDC::MaxY functions.
+        Adds the specified point to the bounding box which can be retrieved
+        with wxDC::MinX(), wxDC::MaxX() and wxDC::MinY(), wxDC::MaxY()
+        functions.
     */
     void CalcBoundingBox(wxCoord x, wxCoord y);
 
     /**
     */
     void CalcBoundingBox(wxCoord x, wxCoord y);
 
     /**
-        This makes no sense in wxSVGFileDC and does nothing
+        This makes no sense in wxSVGFileDC and does nothing.
     */
     void Clear();
 
     /**
     */
     void Clear();
 
     /**
-        Not Implemented
+        Not Implemented.
     */
     void CrossHair(wxCoord x, wxCoord y);
 
     /**
     */
     void CrossHair(wxCoord x, wxCoord y);
 
     /**
-        Not Implemented
+        Not Implemented.
     */
     void DestroyClippingRegion();
 
     */
     void DestroyClippingRegion();
 
@@ -107,9 +100,9 @@ public:
     wxCoord DeviceToLogicalX(wxCoord x);
 
     /**
     wxCoord DeviceToLogicalX(wxCoord x);
 
     /**
-        Convert device X coordinate to relative logical coordinate, using the current
-        mapping mode but ignoring the x axis orientation.
-        Use this function for converting a width, for example.
+        Convert device X coordinate to relative logical coordinate, using the
+        current mapping mode but ignoring the x axis orientation. Use this
+        function for converting a width, for example.
     */
     wxCoord DeviceToLogicalXRel(wxCoord x);
 
     */
     wxCoord DeviceToLogicalXRel(wxCoord x);
 
@@ -120,35 +113,34 @@ public:
     wxCoord DeviceToLogicalY(wxCoord y);
 
     /**
     wxCoord DeviceToLogicalY(wxCoord y);
 
     /**
-        Convert device Y coordinate to relative logical coordinate, using the current
-        mapping mode but ignoring the y axis orientation.
-        Use this function for converting a height, for example.
+        Convert device Y coordinate to relative logical coordinate, using the
+        current mapping mode but ignoring the y axis orientation. Use this
+        function for converting a height, for example.
     */
     wxCoord DeviceToLogicalYRel(wxCoord y);
 
     /**
     */
     wxCoord DeviceToLogicalYRel(wxCoord y);
 
     /**
-        Draws an arc of a circle, centred on (@e xc, yc), with starting point (@e x1,
-        y1)
-        and ending at (@e x2, y2).   The current pen is used for the outline
-        and the current brush for filling the shape.
-        
-        The arc is drawn in an anticlockwise direction from the start point to the end
-        point.
+        Draws an arc of a circle, centred on (@a xc, @a yc), with starting
+        point (@a x1, @a y1) and ending at (@a x2, @a y2). The current pen is
+        used for the outline and the current brush for filling the shape.
+
+        The arc is drawn in a counter-clockwise direction from the start point
+        to the end point.
     */
     void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
                  wxCoord xc, wxCoord yc);
 
     /**
     */
     void DrawArc(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
                  wxCoord xc, wxCoord yc);
 
     /**
-        Draw a bitmap on the device context at the specified point. If @e transparent
-        is @true and the bitmap has
-        a transparency mask, the bitmap will be drawn transparently.
-        
-        When drawing a mono-bitmap, the current text foreground colour will be used to
-        draw the foreground
-        of the bitmap (all bits set to 1), and the current text background colour to
-        draw the background
-        (all bits set to 0). See also wxDC::SetTextForeground, 
-        wxDC::SetTextBackground and wxMemoryDC.
+        Draw a bitmap on the device context at the specified point. If
+        @a transparent is @true and the bitmap has a transparency mask, the
+        bitmap will be drawn transparently.
+
+        When drawing a mono-bitmap, the current text foreground colour will be
+        used to draw the foreground of the bitmap (all bits set to 1), and the
+        current text background colour to draw the background (all bits set to
+        0).
+
+        @see wxDC::SetTextForeground(), wxDC::SetTextBackground(), wxMemoryDC
     */
     void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y,
                     bool transparent);
     */
     void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y,
                     bool transparent);
@@ -157,82 +149,76 @@ public:
     /**
         Draws a check mark inside the given rectangle.
     */
     /**
         Draws a check mark inside the given rectangle.
     */
-    void DrawCheckMark(wxCoord x, wxCoord y, wxCoord width,
-                       wxCoord height);
-        void DrawCheckMark(const wxRect & rect);
+    void DrawCheckMark(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
+    void DrawCheckMark(const wxRect& rect);
     //@}
 
     //@{
     /**
         Draws a circle with the given centre and radius.
     //@}
 
     //@{
     /**
         Draws a circle with the given centre and radius.
-        
-        @sa wxDC::DrawEllipse
+
+        @see wxDC::DrawEllipse()
     */
     void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
     */
     void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
-        void DrawCircle(const wxPoint& pt, wxCoord radius);
+    void DrawCircle(const wxPoint& pt, wxCoord radius);
     //@}
 
     //@{
     /**
     //@}
 
     //@{
     /**
-        Draws an ellipse contained in the rectangle specified either with the given top
-        left corner and the given size or directly. The current pen is used for the
-        outline and the current brush for filling the shape.
-        
-        @sa wxDC::DrawCircle
+        Draws an ellipse contained in the rectangle specified either with the
+        given top left corner and the given size or directly. The current pen
+        is used for the outline and the current brush for filling the shape.
+
+        @see wxDC::DrawCircle()
     */
     */
-    void DrawEllipse(wxCoord x, wxCoord y, wxCoord width,
-                     wxCoord height);
-        void DrawEllipse(const wxPoint& pt, const wxSize& size);
-        void DrawEllipse(const wxRect& rect);
+    void DrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
+    void DrawEllipse(const wxPoint& pt, const wxSize& size);
+    void DrawEllipse(const wxRect& rect);
     //@}
 
     /**
     //@}
 
     /**
-        Draws an arc of an ellipse. The current pen is used for drawing the arc and
-        the current brush is used for drawing the pie.
-        
-        @e x and @e y specify the x and y coordinates of the upper-left corner of the
-        rectangle that contains
-        the ellipse.
-        
-        @e width and @e height specify the width and height of the rectangle that
-        contains
-        the ellipse.
-        
-        @e start and @e end specify the start and end of the arc relative to the
-        three-o'clock
-        position from the center of the rectangle. Angles are specified
-        in degrees (360 is a complete circle). Positive values mean
-        counter-clockwise motion. If @e start is equal to @e end, a
-        complete ellipse will be drawn.
-    */
-    void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord width,
-                         wxCoord height,
-                         double start,
-                         double end);
-
-    /**
-        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.
+        Draws an arc of an ellipse. The current pen is used for drawing the arc
+        and the current brush is used for drawing the pie.
+
+        @a x and @a y specify the x and y coordinates of the upper-left corner
+        of the rectangle that contains the ellipse.
+
+        @a width and @a height specify the width and height of the rectangle
+        that contains the ellipse.
+
+        @a start and @a end specify the start and end of the arc relative to
+        the three-o'clock position from the center of the rectangle. Angles are
+        specified in degrees (360 is a complete circle). Positive values mean
+        counter-clockwise motion. If @a start is equal to @a end, a complete
+        ellipse will be drawn.
+    */
+    void DrawEllipticArc(wxCoord x, wxCoord y, wxCoord width, wxCoord height,
+                         double start, double end);
+
+    /**
+        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.
     */
     void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 
     /**
     */
     void DrawIcon(const wxIcon& icon, wxCoord x, wxCoord y);
 
     /**
-        Draws a line from the first point to the second. The current pen is used
-        for drawing the line.
+        Draws a line from the first point to the second. The current pen is
+        used for drawing the line.
     */
     void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 
     //@{
     /**
     */
     void DrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
 
     //@{
     /**
-        Draws lines using an array of @e points of size @e n, or list of
+        Draws lines using an array of @a points of size @a n, or list of
         pointers to points, adding the optional offset coordinate. The current
         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.
     */
     void DrawLines(int n, wxPoint points[], wxCoord xoffset = 0,
                    wxCoord yoffset = 0);
         deleting the list of points.
     */
     void DrawLines(int n, wxPoint points[], wxCoord xoffset = 0,
                    wxCoord yoffset = 0);
-        void DrawLines(wxList * points, wxCoord xoffset = 0,
-                       wxCoord yoffset = 0);
+    void DrawLines(wxList* points, wxCoord xoffset = 0,
+                   wxCoord yoffset = 0);
     //@}
 
     /**
     //@}
 
     /**
@@ -242,24 +228,22 @@ public:
 
     //@{
     /**
 
     //@{
     /**
-        Draws a filled polygon using an array of @e points of size @e n,
+        Draws a filled polygon using an array of @a points of size @a n,
         or list of pointers to points, adding the optional offset coordinate.
         or list of pointers to points, adding the optional offset coordinate.
-        
-        The last argument specifies the fill rule: @b wxODDEVEN_RULE (the
-        default) or @b wxWINDING_RULE.
-        
+        wxWidgets automatically closes the first and last points.
+
+        The last argument specifies the fill rule: @c wxODDEVEN_RULE (the
+        default) or @c wxWINDING_RULE.
+
         The current pen is used for drawing the outline, and the current brush
         The current pen is used for drawing the outline, and the current brush
-        for filling the shape.  Using a transparent brush suppresses filling.
+        for filling the shape. Using a transparent brush suppresses filling.
+
         The programmer is responsible for deleting the list of points.
         The programmer is responsible for deleting the list of points.
-        
-        Note that wxWindows automatically closes the first and last points.
     */
     void DrawPolygon(int n, wxPoint points[], wxCoord xoffset = 0,
     */
     void DrawPolygon(int n, wxPoint points[], wxCoord xoffset = 0,
-                     wxCoord yoffset = 0,
-                     int fill_style = wxODDEVEN_RULE);
-        void DrawPolygon(wxList * points, wxCoord xoffset = 0,
-                         wxCoord yoffset = 0,
-                         int fill_style = wxODDEVEN_RULE);
+                     wxCoord yoffset = 0, int fill_style = wxODDEVEN_RULE);
+    void DrawPolygon(wxList* points, wxCoord xoffset = 0,
+                     wxCoord yoffset = 0, int fill_style = wxODDEVEN_RULE);
     //@}
 
     /**
     //@}
 
     /**
@@ -267,14 +251,13 @@ public:
         size.  The current pen is used for the outline and the current brush
         for filling the shape.
     */
         size.  The current pen is used for the outline and the current brush
         for filling the shape.
     */
-    void DrawRectangle(wxCoord x, wxCoord y, wxCoord width,
-                       wxCoord height);
+    void DrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 
     /**
 
     /**
-        Draws the text rotated by @e angle degrees.
-        
-        The wxMSW wxDC and wxSVGFileDC rotate the text around slightly different
-        points, depending on the size of the font
+        Draws the text rotated by @a angle degrees.
+
+        The wxMSW wxDC and wxSVGFileDC rotate the text around slightly
+        different points, depending on the size of the font.
     */
     void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
                          double angle);
     */
     void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
                          double angle);
@@ -284,84 +267,88 @@ public:
         size.  The corners are quarter-circles using the given radius. The
         current pen is used for the outline and the current brush for filling
         the shape.
         size.  The corners are quarter-circles using the given radius. The
         current pen is used for the outline and the current brush for filling
         the shape.
-        
-        If @e radius is positive, the value is assumed to be the
-        radius of the rounded corner. If @e radius is negative,
-        the absolute value is assumed to be the @e proportion of the smallest
-        dimension of the rectangle. This means that the corner can be
-        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 rectangle.
+
+        If @a radius is positive, the value is assumed to be the radius of the
+        rounded corner. If @a radius is negative, the absolute value is assumed
+        to be the @e proportion of the smallest dimension of the rectangle.
+        This means that the corner can be 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 rectangle.
     */
     void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width,
     */
     void DrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width,
-                              wxCoord height,
-                              double radius = 20);
+                              wxCoord height, double radius = 20);
 
 
-    //@{
     /**
     /**
+        Draws a spline between all given control points, using the current pen.
+        The programmer is responsible for deleting the list of points. The
+        spline is drawn using a series of lines, using an algorithm taken from
+        the X drawing program "XFIG".
+    */
+    void DrawSpline(wxList* points);
+    /**
+        @param string
+            The text string to measure.
         Draws a three-point spline using the current pen.
     */
         Draws a three-point spline using the current pen.
     */
-    void DrawSpline(wxList * points);
-        void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2,
-                        wxCoord y2,
-                        wxCoord x3,
-                        wxCoord y3);
-    //@}
+    void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
+                    wxCoord x3, wxCoord y3);
 
     /**
 
     /**
-        Draws a text string at the specified point, using the current text font,
-        and the current text foreground and background colours.
-        
+        Draws a text string at the specified point, using the current text
+        font, and the current text foreground and background colours.
+
         The coordinates refer to the top-left corner of the rectangle bounding
         The coordinates refer to the top-left corner of the rectangle bounding
-        the string. See GetTextExtent() for how
-        to get the dimensions of a text string, which can be used to position the
-        text more precisely.
+        the string. See wxDC::GetTextExtent() for how to get the dimensions of
+        a text string, which can be used to position the text more precisely.
     */
     void DrawText(const wxString& text, wxCoord x, wxCoord y);
 
     /**
     */
     void DrawText(const wxString& text, wxCoord x, wxCoord y);
 
     /**
-        Does nothing
+        Does nothing.
     */
     void EndDoc();
 
     /**
     */
     void EndDoc();
 
     /**
-        Does nothing
+        Does nothing.
     */
     void EndDrawing();
 
     /**
     */
     void EndDrawing();
 
     /**
-        Does nothing
+        Does nothing.
     */
     void EndPage();
 
     /**
     */
     void EndPage();
 
     /**
-        Not implemented
+        Not implemented.
     */
     void FloodFill(wxCoord x, wxCoord y, const wxColour& colour,
     */
     void FloodFill(wxCoord x, wxCoord y, const wxColour& colour,
-                   int style=wxFLOOD_SURFACE);
+                   int style = wxFLOOD_SURFACE);
 
     //@{
     /**
 
     //@{
     /**
-        Gets the brush used for painting the background (see
-        wxSVGFileDC::SetBackground).
+        Gets the brush used for painting the background.
+
+        @see SetBackground()
     */
     */
-    wxBrush GetBackground();
-        const wxBrush GetBackground();
+    wxBrush GetBackground() const;
+    const wxBrush GetBackground() const;
     //@}
 
     /**
         Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
     //@}
 
     /**
         Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
-        
-        @sa wxDC::SetBackgroundMode
+
+        @see SetBackgroundMode()
     */
     */
-    int GetBackgroundMode();
+    int GetBackgroundMode() const;
 
     //@{
     /**
 
     //@{
     /**
-        Gets the current brush (see wxSVGFileDC::SetBrush).
+        Gets the current brush.
+
+        @see SetBrush()
     */
     */
-    wxBrush GetBrush();
-        const wxBrush GetBrush();
+    wxBrush GetBrush() const;
+    const wxBrush GetBrush() const;
     //@}
 
     /**
     //@}
 
     /**
@@ -375,87 +362,106 @@ public:
     wxCoord GetCharWidth();
 
     /**
     wxCoord GetCharWidth();
 
     /**
-        Not implemented
+        Not implemented.
     */
     */
-    void GetClippingBox(wxCoord x, wxCoord y, wxCoord width,
-                        wxCoord height);
+    void GetClippingBox(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
 
     //@{
     /**
 
     //@{
     /**
-        Gets the current font (see wxSVGFileDC::SetFont).
+        Gets the current font.
+
+        @see SetFont()
     */
     */
-    wxFont GetFont();
-        const wxFont GetFont();
+    wxFont GetFont() const;
+    const wxFont GetFont() const;
     //@}
 
     /**
     //@}
 
     /**
-        Gets the current logical function (see wxSVGFileDC::SetLogicalFunction).
+        Gets the current logical function.
+
+        @see SetLogicalFunction()
     */
     int GetLogicalFunction();
 
     /**
     */
     int GetLogicalFunction();
 
     /**
-        Gets the @e mapping mode for the device context (see wxSVGFileDC::SetMapMode).
+        Gets the mapping mode for the device context.
+
+        @see SetMapMode()
     */
     int GetMapMode();
 
     //@{
     /**
     */
     int GetMapMode();
 
     //@{
     /**
-        Gets the current pen (see wxSVGFileDC::SetPen).
+        Gets the current pen.
+
+        @see SetPen()
     */
     */
-    wxPen GetPen();
-        const wxPen GetPen();
+    wxPen GetPen() const;
+    const wxPen GetPen() const;
     //@}
 
     /**
     //@}
 
     /**
-        Not implemented
+        Not implemented.
     */
     */
-    bool GetPixel(wxCoord x, wxCoord y, wxColour * colour);
+    bool GetPixel(wxCoord x, wxCoord y, wxColour* colour);
 
     /**
 
     /**
-        For a Windows printer device context, this gets the horizontal and vertical
-        resolution.
+        For a Windows printer device context, this gets the horizontal and
+        vertical resolution.
     */
     */
-    void GetSize(wxCoord * width, wxCoord * height);
+    void GetSize(wxCoord* width, wxCoord* height);
 
     //@{
     /**
 
     //@{
     /**
-        Gets the current text background colour (see wxSVGFileDC::SetTextBackground).
+        Gets the current text background colour.
+
+        @see SetTextBackground()
     */
     */
-    wxColour GetTextBackground();
-        const wxColour GetTextBackground();
+    wxColour GetTextBackground() const;
+    const wxColour GetTextBackground() const;
     //@}
 
     /**
         Gets the dimensions of the string using the currently selected font.
     //@}
 
     /**
         Gets the dimensions of the string using the currently selected font.
-        @e string is the text string to measure, @e w and @e h are
-        the total width and height respectively, @e descent is the
-        dimension from the baseline of the font to the bottom of the
-        descender, and @e externalLeading is any extra vertical space added
-        to the font by the font designer (usually is zero).
-        
-        The optional parameter @e font specifies an alternative
-        to the currently selected font: but note that this does not
-        yet work under Windows, so you need to set a font for
-        the device context first.
-        
-        See also wxFont, SetFont().
-    */
-    void GetTextExtent(const wxString& string, wxCoord * w,
-                       wxCoord * h,
-                       wxCoord * descent = @NULL,
-                       wxCoord * externalLeading = @NULL,
-                       wxFont * font = @NULL);
+
+        @param string
+            The text string to measure.
+        @param w
+            This value will be set to the width after this call.
+        @param h
+            This value will be set to the height after this call.
+        @param descent
+            The dimension from the baseline of the font to the bottom of the
+            descender.
+        @param externalLeading
+            Any extra vertical space added to the font by the font designer
+            (usually is zero).
+
+        The optional parameter @a font specifies an alternative to the
+        currently selected font: but note that this does not yet work under
+        Windows, so you need to set a font for the device context first.
+
+        @see wxFont, SetFont()
+    */
+    void GetTextExtent(const wxString& string, wxCoord* w, wxCoord* h,
+                       wxCoord* descent = NULL,
+                       wxCoord* externalLeading = NULL,
+                       wxFont* font = NULL);
 
     //@{
     /**
 
     //@{
     /**
-        Gets the current text foreground colour (see wxSVGFileDC::SetTextForeground).
+        Gets the current text foreground colour.
+
+        @see SetTextForeground()
     */
     */
-    wxColour GetTextForeground();
-        const wxColour GetTextForeground();
+    wxColour GetTextForeground() const;
+    const wxColour GetTextForeground() const;
     //@}
 
     /**
     //@}
 
     /**
-        Gets the current user scale factor (set by wxDC::SetUserScale).
+        Gets the current user scale factor.
+
+        @see SetUserScale()
     */
     void GetUserScale(double x, double y);
 
     */
     void GetUserScale(double x, double y);
 
@@ -466,9 +472,9 @@ public:
     wxCoord LogicalToDeviceX(wxCoord x);
 
     /**
     wxCoord LogicalToDeviceX(wxCoord x);
 
     /**
-        Converts logical X coordinate to relative device coordinate, using the current
-        mapping mode but ignoring the x axis orientation.
-        Use this for converting a width, for example.
+        Converts logical X coordinate to relative device coordinate, using the
+        current mapping mode but ignoring the x axis orientation. Use this for
+        converting a width, for example.
     */
     wxCoord LogicalToDeviceXRel(wxCoord x);
 
     */
     wxCoord LogicalToDeviceXRel(wxCoord x);
 
@@ -479,43 +485,43 @@ public:
     wxCoord LogicalToDeviceY(wxCoord y);
 
     /**
     wxCoord LogicalToDeviceY(wxCoord y);
 
     /**
-        Converts logical Y coordinate to relative device coordinate, using the current
-        mapping mode but ignoring the y axis orientation.
-        Use this for converting a height, for example.
+        Converts logical Y coordinate to relative device coordinate, using the
+        current mapping mode but ignoring the y axis orientation. Use this for
+        converting a height, for example.
     */
     wxCoord LogicalToDeviceYRel(wxCoord y);
 
     /**
         Gets the maximum horizontal extent used in drawing commands so far.
     */
     */
     wxCoord LogicalToDeviceYRel(wxCoord y);
 
     /**
         Gets the maximum horizontal extent used in drawing commands so far.
     */
-#define wxCoord MaxX()     /* implementation is private */
+    wxCoord MaxX();
 
     /**
         Gets the maximum vertical extent used in drawing commands so far.
     */
 
     /**
         Gets the maximum vertical extent used in drawing commands so far.
     */
-#define wxCoord MaxY()     /* implementation is private */
+    wxCoord MaxY();
 
     /**
         Gets the minimum horizontal extent used in drawing commands so far.
     */
 
     /**
         Gets the minimum horizontal extent used in drawing commands so far.
     */
-#define wxCoord MinX()     /* implementation is private */
+    wxCoord MinX();
 
     /**
         Gets the minimum vertical extent used in drawing commands so far.
     */
 
     /**
         Gets the minimum vertical extent used in drawing commands so far.
     */
-#define wxCoord MinY()     /* implementation is private */
+    wxCoord MinY();
 
     /**
 
     /**
-        Returns @true if the DC is ok to use; False values arise from being unable to 
-        write the file
+        Returns @true if the DC is ok to use. @false values arise from being
+        unable to write the file.
     */
     */
-#define bool Ok()     /* implementation is private */
+    bool Ok();
 
     /**
 
     /**
-        Resets the bounding box: after a call to this function, the bounding box
-        doesn't contain anything.
-        
-        @sa wxDC::CalcBoundingBox
+        Resets the bounding box. After a call to this function, the bounding
+        box doesn't contain anything.
+
+        @see CalcBoundingBox()
     */
     void ResetBoundingBox();
 
     */
     void ResetBoundingBox();
 
@@ -523,14 +529,13 @@ public:
         Sets the x and y axis orientation (i.e., the direction from lowest to
         highest values on the axis). The default orientation is the natural
         orientation, e.g. x axis from left to right and y axis from bottom up.
         Sets the x and y axis orientation (i.e., the direction from lowest to
         highest values on the axis). The default orientation is the natural
         orientation, e.g. x axis from left to right and y axis from bottom up.
-        
-        @param xLeftRight 
-        True to set the x axis orientation to the natural
-        left to right orientation, @false to invert it.
-        
-        @param yBottomUp 
-        True to set the y axis orientation to the natural
-        bottom up orientation, @false to invert it.
+
+        @param xLeftRight
+            @true to set the x axis orientation to the natural left to right
+            orientation, @false to invert it.
+        @param yBottomUp
+            @true to set the y axis orientation to the natural bottom up
+            orientation, @false to invert it.
     */
     void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
 
     */
     void SetAxisOrientation(bool xLeftRight, bool yBottomUp);
 
@@ -540,117 +545,91 @@ public:
     void SetBackground(const wxBrush& brush);
 
     /**
     void SetBackground(const wxBrush& brush);
 
     /**
-        @e mode may be one of wxSOLID and wxTRANSPARENT. This setting determines
+        @a mode may be one of wxSOLID and wxTRANSPARENT. This setting determines
         whether text will be drawn with a background colour or not.
     */
     void SetBackgroundMode(int mode);
 
     /**
         whether text will be drawn with a background colour or not.
     */
     void SetBackgroundMode(int mode);
 
     /**
-        Sets the current brush for the DC.
-        
-        If the argument is wxNullBrush, the current brush is selected out of the device
-        context, and the original brush restored, allowing the current brush to
-        be destroyed safely.
-        
-        See also wxBrush.
-        
-        See also wxMemoryDC for the interpretation of colours
-        when drawing into a monochrome bitmap.
+        Sets the current brush for the DC. If the argument is wxNullBrush, the
+        current brush is selected out of the device context, and the original
+        brush restored, allowing the current brush to be destroyed safely.
+
+        @see wxBrush, wxMemoryDC (for the interpretation of colours
+             when drawing into a monochrome bitmap).
     */
     void SetBrush(const wxBrush& brush);
 
     //@{
     /**
     */
     void SetBrush(const wxBrush& brush);
 
     //@{
     /**
-        Not implemented
+        Not implemented.
     */
     void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width,
                            wxCoord height);
     */
     void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width,
                            wxCoord height);
-        void SetClippingRegion(const wxPoint& pt, const wxSize& sz);
-        void SetClippingRegion(const wxRect& rect);
-        void SetClippingRegion(const wxRegion& region);
+    void SetClippingRegion(const wxPoint& pt, const wxSize& sz);
+    void SetClippingRegion(const wxRect& rect);
+    void SetClippingRegion(const wxRegion& region);
     //@}
 
     /**
     //@}
 
     /**
-        Sets the device origin (i.e., the origin in pixels after scaling has been
-        applied).
-        
-        This function may be useful in Windows printing
+        Sets the device origin (i.e., the origin in pixels after scaling has
+        been applied). This function may be useful in Windows printing
         operations for placing a graphic on a page.
     */
     void SetDeviceOrigin(wxCoord x, wxCoord y);
 
     /**
         operations for placing a graphic on a page.
     */
     void SetDeviceOrigin(wxCoord x, wxCoord y);
 
     /**
-        Sets the current font for the DC. It must be a valid font, in particular you
-        should not pass @c wxNullFont to this method.
-        
-        See also wxFont.
+        Sets the current font for the DC. It must be a valid font, in
+        particular you should not pass @c wxNullFont to this method.
+
+        @see wxFont
     */
     void SetFont(const wxFont& font);
 
     /**
     */
     void SetFont(const wxFont& font);
 
     /**
-        Only wxCOPY is avalaible; trying to set one of the othe values will fail
+        Does the same as wxDC::SetLogicalFunction(), except that only wxCOPY is
+        avalaible. Trying to set one of the othe values will fail.
     */
     void SetLogicalFunction(int function);
 
     /**
     */
     void SetLogicalFunction(int function);
 
     /**
-        The @e mapping mode of the device context defines the unit of
-        measurement used to convert logical units to device units. Note that
-        in X, text drawing isn't handled consistently with the mapping mode; a
-        font is always specified in point size. However, setting the @e user scale (see
-        wxSVGFileDC::SetUserScale) scales the text appropriately. In
-        Windows, scaleable TrueType fonts are always used; in X, results depend
-        on availability of fonts, but usually a reasonable match is found.
-        
+        The mapping mode of the device context defines the unit of measurement
+        used to convert logical units to device units. Note that in X, text
+        drawing isn't handled consistently with the mapping mode; a font is
+        always specified in point size. However, setting the user scale scales
+        the text appropriately. In Windows, scalable TrueType fonts are always
+        used; in X, results depend on availability of fonts, but usually a
+        reasonable match is found.
+
         Note that the coordinate origin should ideally be selectable, but for
         now is always at the top left of the screen/printer.
         Note that the coordinate origin should ideally be selectable, but for
         now is always at the top left of the screen/printer.
-        
-        Drawing to a Windows printer device context under UNIX
-        uses the current mapping mode, but mapping mode is currently ignored for
-        PostScript output.
-        
+
+        Drawing to a Windows printer device context under UNIX uses the current
+        mapping mode, but mapping mode is currently ignored for PostScript
+        output.
+
         The mapping mode can be one of the following:
         The mapping mode can be one of the following:
-        
-        wxMM_TWIPS
-        
-        
-        Each logical unit is 1/20 of a point, or 1/1440 of
-          an inch.
-        
-        wxMM_POINTS
-        
-        
-        Each logical unit is a point, or 1/72 of an inch.
-        
-        wxMM_METRIC
-        
-        
-        Each logical unit is 1 mm.
-        
-        wxMM_LOMETRIC
-        
-        
-        Each logical unit is 1/10 of a mm.
-        
-        wxMM_TEXT
-        
-        
-        Each logical unit is 1 pixel.
-    */
-    void SetMapMode(int int);
-
-    /**
-        Not implemented
+        - wxMM_TWIPS    - Each logical unit is 1/20 of a point, or 1/1440 of an
+                          inch.
+        - wxMM_POINTS   - Each logical unit is a point, or 1/72 of an inch.
+        - wxMM_METRIC   - Each logical unit is 1 mm.
+        - wxMM_LOMETRIC - Each logical unit is 1/10 of a mm.
+        - wxMM_TEXT     - Each logical unit is 1 pixel.
+    */
+    void SetMapMode(int mode);
+
+    /**
+        Not implemented.
     */
     void SetPalette(const wxPalette& palette);
 
     /**
     */
     void SetPalette(const wxPalette& palette);
 
     /**
-        Sets the current pen for the DC.
-        
-        If the argument is wxNullPen, the current pen is selected out of the device
-        context, and the original pen restored.
-        
-        See also wxMemoryDC for the interpretation of colours
-        when drawing into a monochrome bitmap.
+        Sets the current pen for the DC. If the argument is wxNullPen, the
+        current pen is selected out of the device context, and the original pen
+        restored.
+
+        @see wxMemoryDC (for the interpretation of colours when drawing into a
+             monochrome bitmap)
     */
     void SetPen(const wxPen& pen);
 
     */
     void SetPen(const wxPen& pen);
 
@@ -661,20 +640,21 @@ public:
 
     /**
         Sets the current text foreground colour for the DC.
 
     /**
         Sets the current text foreground colour for the DC.
-        
-        See also wxMemoryDC for the interpretation of colours
-        when drawing into a monochrome bitmap.
+
+        @see wxMemoryDC (for the interpretation of colours when drawing into a
+             monochrome bitmap)
     */
     void SetTextForeground(const wxColour& colour);
 
     /**
         Sets the user scaling factor, useful for applications which require
     */
     void SetTextForeground(const wxColour& colour);
 
     /**
         Sets the user scaling factor, useful for applications which require
-        'zooming'.
+        "zooming".
     */
     void SetUserScale(double xScale, double yScale);
 
     /**
     */
     void SetUserScale(double xScale, double yScale);
 
     /**
-        Does nothing
+        Does nothing.
     */
     bool StartDoc(const wxString& message);
 };
     */
     bool StartDoc(const wxString& message);
 };
+
wxWidgets (Impactor)