clarify wxListCtrl::GetItem (fixes #9640)

[wxWidgets.git] / interface / wx / dcsvg.h

diff --git a/interface/wx/dcsvg.h b/interface/wx/dcsvg.h
index bae993d5a35338513a9c9c4ea8d9f7b1965aa760..73b699d67d084e25ba337f8ff4307ade682a2f40 100644 (file)
--- a/interface/wx/dcsvg.h
+++ b/interface/wx/dcsvg.h
@@ -8,7 +8,6 @@
 
 /**
     @class wxSVGFileDC
 
 /**
     @class wxSVGFileDC

-    @wxheader{dcsvg.h}

 
     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
 
     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


@@ -37,26 +36,16 @@
 class wxSVGFileDC : public wxDC
 {
 public:
 class wxSVGFileDC : public wxDC
 {
 public:

-    /**
-        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);
-    /**
-        Initializes a wxSVGFileDC with the given @a f filename with the given
-        @a Width and @a Height at 72.0 dots per inch.
-    */
-    wxSVGFileDC(wxString f, int Width, int Height);

     /**
         Initializes a wxSVGFileDC with the given @a f filename with the given
         @a Width and @a Height at @a dpi resolution.
     */
     /**
         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);
+    wxSVGFileDC(const wxString& filename, int width = 320, int height = 240, double dpi = 72);

 
     /**
         Destructor.
     */
 
     /**
         Destructor.
     */

-    ~wxSVGFileDC();
+    virtual ~wxSVGFileDC();

 
     /**
         Copies from a source DC to this DC, specifying the destination
 
     /**
         Copies from a source DC to this DC, specifying the destination


@@ -67,9 +56,9 @@ public:
         @see wxDC::Blit()
     */
     bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
         @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);
+              wxDC* source, wxCoord xsrc, wxCoord ysrc, int rop = wxCOPY,
+              bool useMask = false, wxCoord xsrcMask = wxDefaultCoord,
+              wxCoord ysrcMask = wxDefaultCoord);

 
     /**
         Adds the specified point to the bounding box which can be retrieved
 
     /**
         Adds the specified point to the bounding box which can be retrieved


@@ -97,27 +86,27 @@ public:
         Convert device X coordinate to logical coordinate, using the current
         mapping mode.
     */
         Convert device X coordinate to logical coordinate, using the current
         mapping mode.
     */

-    wxCoord DeviceToLogicalX(wxCoord x);
+    wxCoord DeviceToLogicalX(wxCoord x) const;

 
     /**
         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) const;

 
     /**
         Converts device Y coordinate to logical coordinate, using the current
         mapping mode.
     */
 
     /**
         Converts device Y coordinate to logical coordinate, using the current
         mapping mode.
     */

-    wxCoord DeviceToLogicalY(wxCoord y);
+    wxCoord DeviceToLogicalY(wxCoord y) const;

 
     /**
         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) const;

 
     /**
         Draws an arc of a circle, centred on (@a xc, @a yc), with starting
 
     /**
         Draws an arc of a circle, centred on (@a xc, @a yc), with starting


@@ -132,7 +121,7 @@ public:
 
     /**
         Draw a bitmap on the device context at the specified point. If
 
     /**
         Draw a bitmap on the device context at the specified point. If

-        @a transparent is @true and the bitmap has a transparency mask, the
+        @a useMask 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
         bitmap will be drawn transparently.
 
         When drawing a mono-bitmap, the current text foreground colour will be


@@ -143,7 +132,7 @@ public:
         @see wxDC::SetTextForeground(), wxDC::SetTextBackground(), wxMemoryDC
     */
     void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y,
         @see wxDC::SetTextForeground(), wxDC::SetTextBackground(), wxMemoryDC
     */
     void DrawBitmap(const wxBitmap& bitmap, wxCoord x, wxCoord y,

-                    bool transparent);
+                    bool useMask = false);

 
     //@{
     /**
 
     //@{
     /**


@@ -280,14 +269,13 @@ public:
 
     /**
         Draws a spline between all given control points, using the current pen.
 
     /**
         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 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".
     */
         the X drawing program "XFIG".
     */

-    void DrawSpline(wxList* points);
+    void DrawSpline(const wxPointList* points);
+

     /**
     /**

-        @param string
-            The text string to measure.

         Draws a three-point spline using the current pen.
     */
     void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,
         Draws a three-point spline using the current pen.
     */
     void DrawSpline(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2,


@@ -321,7 +309,7 @@ public:
     /**
         Not implemented.
     */
     /**
         Not implemented.
     */

-    void FloodFill(wxCoord x, wxCoord y, const wxColour& colour,
+    bool FloodFill(wxCoord x, wxCoord y, const wxColour& colour,

                    int style = wxFLOOD_SURFACE);
 
     //@{
                    int style = wxFLOOD_SURFACE);
 
     //@{


@@ -354,17 +342,17 @@ public:
     /**
         Gets the character height of the currently set font.
     */
     /**
         Gets the character height of the currently set font.
     */

-    wxCoord GetCharHeight();
+    wxCoord GetCharHeight() const;

 
     /**
         Gets the average character width of the currently set font.
     */
 
     /**
         Gets the average character width of the currently set font.
     */

-    wxCoord GetCharWidth();
+    wxCoord GetCharWidth() const;

 
     /**
         Not implemented.
     */
 
     /**
         Not implemented.
     */

-    void GetClippingBox(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
+    void GetClippingBox(wxCoord *x, wxCoord *y, wxCoord *width, wxCoord *height) const;

 
     //@{
     /**
 
     //@{
     /**


@@ -381,14 +369,14 @@ public:
 
         @see SetLogicalFunction()
     */
 
         @see SetLogicalFunction()
     */

-    int GetLogicalFunction();
+    int GetLogicalFunction() const;

 
     /**
         Gets the mapping mode for the device context.
 
         @see SetMapMode()
     */
 
     /**
         Gets the mapping mode for the device context.
 
         @see SetMapMode()
     */

-    int GetMapMode();
+    int GetMapMode() const;

 
     //@{
     /**
 
     //@{
     /**


@@ -403,7 +391,7 @@ public:
     /**
         Not implemented.
     */
     /**
         Not implemented.
     */

-    bool GetPixel(wxCoord x, wxCoord y, wxColour* colour);
+    bool GetPixel(wxCoord x, wxCoord y, wxColour* colour) const;

 
     /**
         For a Windows printer device context, this gets the horizontal and
 
     /**
         For a Windows printer device context, this gets the horizontal and


@@ -418,7 +406,7 @@ public:
         @see SetTextBackground()
     */
     wxColour GetTextBackground() const;
         @see SetTextBackground()
     */
     wxColour GetTextBackground() const;

-    const wxColour GetTextBackground() const;
+    const wxColour& GetTextBackground() const;

     //@}
 
     /**
     //@}
 
     /**


@@ -436,17 +424,17 @@ public:
         @param externalLeading
             Any extra vertical space added to the font by the font designer
             (usually is zero).
         @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.
+        @param 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,
 
         @see wxFont, SetFont()
     */
     void GetTextExtent(const wxString& string, wxCoord* w, wxCoord* h,
                        wxCoord* descent = NULL,
                        wxCoord* externalLeading = NULL,

-                       wxFont* font = NULL);
+                       const wxFont* font = NULL) const;

 
     //@{
     /**
 
     //@{
     /**


@@ -463,53 +451,53 @@ public:
 
         @see SetUserScale()
     */
 
         @see SetUserScale()
     */

-    void GetUserScale(double x, double y);
+    void GetUserScale(double* x, double* y) const;

 
     /**
         Converts logical X coordinate to device coordinate, using the current
         mapping mode.
     */
 
     /**
         Converts logical X coordinate to device coordinate, using the current
         mapping mode.
     */

-    wxCoord LogicalToDeviceX(wxCoord x);
+    wxCoord LogicalToDeviceX(wxCoord x) const;

 
     /**
         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) const;

 
     /**
         Converts logical Y coordinate to device coordinate, using the current
         mapping mode.
     */
 
     /**
         Converts logical Y coordinate to device coordinate, using the current
         mapping mode.
     */

-    wxCoord LogicalToDeviceY(wxCoord y);
+    wxCoord LogicalToDeviceY(wxCoord y) const;

 
     /**
         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);
+    wxCoord LogicalToDeviceYRel(wxCoord y) const;

 
     /**
         Gets the maximum horizontal extent used in drawing commands so far.
     */
 
     /**
         Gets the maximum horizontal extent used in drawing commands so far.
     */

-    wxCoord MaxX();
+    wxCoord MaxX() const;

 
     /**
         Gets the maximum vertical extent used in drawing commands so far.
     */
 
     /**
         Gets the maximum vertical extent used in drawing commands so far.
     */

-    wxCoord MaxY();
+    wxCoord MaxY() const;

 
     /**
         Gets the minimum horizontal extent used in drawing commands so far.
     */
 
     /**
         Gets the minimum horizontal extent used in drawing commands so far.
     */

-    wxCoord MinX();
+    wxCoord MinX() const;

 
     /**
         Gets the minimum vertical extent used in drawing commands so far.
     */
 
     /**
         Gets the minimum vertical extent used in drawing commands so far.
     */

-    wxCoord MinY();
+    wxCoord MinY() const;

 
     /**
         Returns @true if the DC is ok to use. @false values arise from being
 
     /**
         Returns @true if the DC is ok to use. @false values arise from being