fixed bug in mouse handling

[wxWidgets.git] / docs / latex / wx / dc.tex

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index e84b28d0546e8dfc363700683005d4b86e19f05a..9af5f09bc430f59f9737cc652972229e8db4c52e 100644 (file)
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -2,7 +2,7 @@
 
 A wxDC is a {\it device context} onto which graphics and text can be drawn.
 It is intended to represent a number of output devices in a generic way,
 
 A wxDC is a {\it device context} onto which graphics and text can be drawn.
 It is intended to represent a number of output devices in a generic way,

-so a canvas has a device context and a printer also has a device context.
+so a window can have a device context associated with it, and a printer also has a device context.

 In this way, the same piece of code may write to a number of different devices,
 if the device context is used as a parameter.
 
 In this way, the same piece of code may write to a number of different devices,
 if the device context is used as a parameter.
 


@@ -13,6 +13,10 @@ only, so refer to this section for most device context information.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/dc.h>
+

 \wxheading{See also}
 
 \helpref{Overview}{dcoverview}
 \wxheading{See also}
 
 \helpref{Overview}{dcoverview}


@@ -48,9 +52,9 @@ released for each drawing operation.
 
 \membersection{wxDC::Blit}\label{wxdcblit}
 
 
 \membersection{wxDC::Blit}\label{wxdcblit}
 

-\func{bool}{Blit}{\param{long}{ xdest}, \param{long}{ ydest}, \param{long}{ width}, \param{long}{ height},
-  \param{wxDC* }{source}, \param{long}{ xsrc}, \param{long}{ ysrc}, \param{int}{ logicalFunc},
-  \param{bool }{useMask}}
+\func{bool}{Blit}{\param{wxCoord}{ xdest}, \param{wxCoord}{ ydest}, \param{wxCoord}{ width}, \param{wxCoord}{ height},
+  \param{wxDC* }{source}, \param{wxCoord}{ xsrc}, \param{wxCoord}{ ysrc}, \param{int}{ logicalFunc = wxCOPY},
+  \param{bool }{useMask = FALSE}}

 
 Copy from a source DC to this DC, specifying the destination
 coordinates, size of area to copy, source DC, source coordinates, and
 
 Copy from a source DC to this DC, specifying the destination
 coordinates, size of area to copy, source DC, source coordinates, and


@@ -100,10 +104,22 @@ There is partial support for Blit in wxPostScriptDC, under X.
 
 See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
 
 
 See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
 

-wxheading{See also}
+\wxheading{See also}

 
 \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
 
 
 \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
 

+\membersection{wxDC::CalcBoundingBox}\label{wxdccalcboundingbox}
+
+\func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}}
+
+Adds the specified point to the bounding box which can be retrieved with 
+\helpref{MinX}{wxdcminx}, \helpref{MaxX}{wxdcmaxx} and 
+\helpref{MinY}{wxdcminy}, \helpref{MaxY}{wxdcmaxy} functions.
+
+\wxheading{See also}
+
+\helpref{ResetBoundingBox}{wxdcresetboundingbox}
+

 \membersection{wxDC::Clear}\label{wxdcclear}
 
 \func{void}{Clear}{\void}
 \membersection{wxDC::Clear}\label{wxdcclear}
 
 \func{void}{Clear}{\void}


@@ -112,10 +128,10 @@ Clears the device context using the current background brush.
 
 \membersection{wxDC::CrossHair}\label{wxdccrosshair}
 
 
 \membersection{wxDC::CrossHair}\label{wxdccrosshair}
 

-\func{void}{CrossHair}{\param{long}{ x}, \param{long}{ y}}
+\func{void}{CrossHair}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}

 
 Displays a cross hair using the current pen. This is a vertical
 
 Displays a cross hair using the current pen. This is a vertical

-and horizontal line the height and width of the canvas, centred
+and horizontal line the height and width of the window, centred

 on the given point.
 
 \membersection{wxDC::DestroyClippingRegion}\label{wxdcdestroyclippingregion}
 on the given point.
 
 \membersection{wxDC::DestroyClippingRegion}\label{wxdcdestroyclippingregion}


@@ -127,43 +143,65 @@ See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}.
 
 \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx}
 
 
 \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx}
 

-\func{long}{DeviceToLogicalX}{\param{long}{ x}}
+\func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}

 
 Convert device X coordinate to logical coordinate, using the current
 mapping mode.
 
 \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel}
 
 
 Convert device X coordinate to logical coordinate, using the current
 mapping mode.
 
 \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel}
 

-\func{long}{DeviceToLogicalXRel}{\param{long}{ x}}
+\func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}

 
 Convert device X coordinate to relative logical coordinate, using the current
 mapping mode. Use this function for converting a width, for example.
 
 \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly}
 
 
 Convert device X coordinate to relative logical coordinate, using the current
 mapping mode. Use this function for converting a width, for example.
 
 \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly}
 

-\func{long}{DeviceToLogicalY}{\param{long}{ y}}
+\func{wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}}

 
 Converts device Y coordinate to logical coordinate, using the current
 mapping mode.
 
 \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel}
 
 
 Converts device Y coordinate to logical coordinate, using the current
 mapping mode.
 
 \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel}
 

-\func{long}{DeviceToLogicalYRel}{\param{long}{ y}}
+\func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}

 
 Convert device Y coordinate to relative logical coordinate, using the current
 mapping mode. Use this function for converting a height, for example.
 
 \membersection{wxDC::DrawArc}\label{wxdcdrawarc}
 
 
 Convert device Y coordinate to relative logical coordinate, using the current
 mapping mode. Use this function for converting a height, for example.
 
 \membersection{wxDC::DrawArc}\label{wxdcdrawarc}
 

-\func{void}{DrawArc}{\param{long}{ x1}, \param{long}{ y1}, \param{long}{ x2}, \param{long}{ y2}, \param{double}{ xc}, \param{double}{ yc}}
+\func{void}{DrawArc}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{double}{ xc}, \param{double}{ yc}}

 
 

-Draws an arc, centred on ({\it xc, yc}), with starting point ({\it x1, y1})
+Draws an arc of a circle, centred on ({\it xc, yc}), with starting point ({\it x1, y1})

 and ending at ({\it x2, y2}).   The current pen is used for the outline
 and the current brush for filling the shape.
 
 and ending at ({\it 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.
+
+\membersection{wxDC::DrawBitmap}\label{wxdcdrawbitmap}
+
+\func{void}{DrawBitmap}{\param{const wxBitmap\&}{ bitmap}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{bool}{ transparent}}
+
+Draw a bitmap on the device context at the specified point. If {\it 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 \helpref{SetTextForeground}{wxdcsettextforeground}, 
+\helpref{SetTextBackground}{wxdcsettextbackground} and \helpref{wxMemoryDC}{wxmemorydc}.
+
+\membersection{wxDC::DrawCheckMark}\label{wxdcdrawcheckmark}
+
+\func{void}{DrawCheckMark}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
+
+\func{void}{DrawCheckMark}{\param{const wxRect \&}{rect}}
+
+Draws a check mark inside the given rectangle.
+

 \membersection{wxDC::DrawEllipse}\label{wxdcdrawellipse}
 
 \membersection{wxDC::DrawEllipse}\label{wxdcdrawellipse}
 

-\func{void}{DrawEllipse}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
+\func{void}{DrawEllipse}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}

 
 Draws an ellipse contained in the rectangle with the given top left corner, and with the
 given size.  The current pen is used for the outline and the current brush for
 
 Draws an ellipse contained in the rectangle with the given top left corner, and with the
 given size.  The current pen is used for the outline and the current brush for


@@ -171,17 +209,16 @@ filling the shape.
 
 \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc}
 
 
 \membersection{wxDC::DrawEllipticArc}\label{wxdcdrawellipticarc}
 

-\func{void}{DrawEllipticArc}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ 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}}
 

-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. This function is currently only available for
-X canvas and PostScript device contexts.
+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.

 
 {\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
 the ellipse.
 
 
 {\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
 the ellipse.
 

-{\it width} and {\it height} specify the width and height of the rectangle that contains 
+{\it width} and {\it height} specify the width and height of the rectangle that contains

 the ellipse.
 
 {\it start} and {\it end} specify the start and end of the arc relative to the three-o'clock
 the ellipse.
 
 {\it start} and {\it end} specify the start and end of the arc relative to the three-o'clock


@@ -192,35 +229,38 @@ complete ellipse will be drawn.
 
 \membersection{wxDC::DrawIcon}\label{wxdcdrawicon}
 
 
 \membersection{wxDC::DrawIcon}\label{wxdcdrawicon}
 

-\func{void}{DrawIcon}{\param{const wxIcon\&}{ icon}, \param{long}{ x}, \param{long}{ 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 canvas.
+This can be the simplest way of drawing bitmaps on a window.

 
 \membersection{wxDC::DrawLine}\label{wxdcdrawline}
 
 
 \membersection{wxDC::DrawLine}\label{wxdcdrawline}
 

-\func{void}{DrawLine}{\param{long}{ x1}, \param{long}{ y1}, \param{long}{ x2}, \param{long}{ 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
 for drawing the line.
 
 \membersection{wxDC::DrawLines}\label{wxdcdrawlines}
 
 
 Draws a line from the first point to the second. The current pen is used
 for drawing the line.
 
 \membersection{wxDC::DrawLines}\label{wxdcdrawlines}
 

-\func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0}}
+\func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}

 
 

-\func{void}{DrawLines}{\param{wxList *}{points}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0}}
+\func{void}{DrawLines}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}

 
 Draws lines using an array of {\it points} of size {\it n}, or list of
 pointers to points, adding the optional offset coordinate. The current
 pen is used for drawing the lines.  The programmer is responsible for
 deleting the list of points.
 
 
 Draws lines using an array of {\it points} of size {\it n}, or list of
 pointers to points, adding the optional offset coordinate. The current
 pen is used for drawing the lines.  The programmer is responsible for
 deleting the list of points.
 

+\pythonnote{The wxPython version of this method accepts a Python list
+of wxPoint objects.}
+

 \membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
 
 \membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
 

-\func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{long}{ xoffset = 0}, \param{long}{ 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}}
 

-\func{void}{DrawPolygon}{\param{wxList *}{points}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0},\\
+\func{void}{DrawPolygon}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\

   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 
 Draws a filled polygon using an array of {\it points} of size {\it n},
   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 
 Draws a filled polygon using an array of {\it points} of size {\it n},


@@ -235,23 +275,36 @@ 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.
 

+\pythonnote{The wxPython version of this method accepts a Python list
+of wxPoint objects.}
+

 \membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
 
 \membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
 

-\func{void}{DrawPoint}{\param{long}{ x}, \param{long}{ y}}
+\func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}

 
 Draws a point using the current pen.
 
 \membersection{wxDC::DrawRectangle}\label{wxdcdrawrectangle}
 
 
 Draws a point using the current pen.
 
 \membersection{wxDC::DrawRectangle}\label{wxdcdrawrectangle}
 

-\func{void}{DrawRectangle}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
+\func{void}{DrawRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}

 
 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
 for filling the shape.
 
 
 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
 for filling the shape.
 

+\membersection{wxDC::DrawRotatedText}\label{wxdcdrawrotatedtext}
+
+\func{void}{DrawRotatedText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{double}{ angle}}
+
+Draws the text rotated by {\it angle} degrees.
+
+\wxheading{See also}
+
+\helpref{DrawText}{wxdcdrawtext}
+

 \membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle}
 
 \membersection{wxDC::DrawRoundedRectangle}\label{wxdcdrawroundedrectangle}
 

-\func{void}{DrawRoundedRectangle}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}, \param{double}{ radius = 20}}
+\func{void}{DrawRoundedRectangle}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}, \param{double}{ radius = 20}}

 
 Draws a rectangle with the given top left corner, and with the given
 size.  The corners are quarter-circles using the given radius. The
 
 Draws a rectangle with the given top left corner, and with the given
 size.  The corners are quarter-circles using the given radius. The


@@ -275,13 +328,16 @@ pen.  Doesn't delete the wxList and contents. The spline is drawn
 using a series of lines, using an algorithm taken from the X drawing
 program `XFIG'.
 
 using a series of lines, using an algorithm taken from the X drawing
 program `XFIG'.
 

-\func{void}{DrawSpline}{\param{long}{ x1}, \param{long}{ y1}, \param{long}{ x2}, \param{long}{ y2}, \param{long}{ x3}, \param{long}{ y3}}
+\func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}}

 
 Draws a three-point spline using the current pen.
 
 
 Draws a three-point spline using the current pen.
 

+\pythonnote{The wxPython version of this method accepts a Python list
+of wxPoint objects.}
+

 \membersection{wxDC::DrawText}\label{wxdcdrawtext}
 
 \membersection{wxDC::DrawText}\label{wxdcdrawtext}
 

-\func{void}{DrawText}{\param{const wxString\& }{text}, \param{long}{ x}, \param{long}{ y}}
+\func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}

 
 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.


@@ -291,6 +347,11 @@ the string. See \helpref{wxDC::GetTextExtent}{wxdcgettextextent} for how
 to get the dimensions of a text string, which can be used to position the
 text more precisely.
 
 to get the dimensions of a text string, which can be used to position the
 text more precisely.
 

+{\bf NB:} under wxGTK the current 
+\helpref{logical function}{wxdcgetlogicalfunction} is used by this function
+but it is ignored by wxMSW. Thus, you should avoid using logical functions
+with this function in portable programs.
+

 \membersection{wxDC::EndDoc}\label{wxdcenddoc}
 
 \func{void}{EndDoc}{\void}
 \membersection{wxDC::EndDoc}\label{wxdcenddoc}
 
 \func{void}{EndDoc}{\void}


@@ -313,10 +374,10 @@ Ends a document page (only relevant when outputting to a printer).
 
 \membersection{wxDC::FloodFill}\label{wxdcfloodfill}
 
 
 \membersection{wxDC::FloodFill}\label{wxdcfloodfill}
 

-\func{void}{FloodFill}{\param{long}{ x}, \param{long}{ y}, \param{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}}

 
 

-Flood fills the device context starting from the given point, in the given colour,
-and using a style:
+Flood fills the device context starting from the given point, using
+the {\it current brush colour}, and using a style:

 
 \begin{itemize}\itemsep=0pt
 \item wxFLOOD\_SURFACE: the flooding occurs until a colour other than the given colour is encountered.
 
 \begin{itemize}\itemsep=0pt
 \item wxFLOOD\_SURFACE: the flooding occurs until a colour other than the given colour is encountered.


@@ -327,37 +388,56 @@ and using a style:
 
 \membersection{wxDC::GetBackground}\label{wxdcgetbackground}
 
 
 \membersection{wxDC::GetBackground}\label{wxdcgetbackground}
 

-\func{wxBrush *}{GetBackground}{\void}
+\func{wxBrush\&}{GetBackground}{\void}
+
+\constfunc{const wxBrush\&}{GetBackground}{\void}

 
 Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}).
 
 
 Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}).
 

+\membersection{wxDC::GetBackgroundMode}\label{wxdcgetbackgroundmode}
+
+\constfunc{int}{GetBackgroundMode}{\void}
+
+Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
+
+\wxheading{See also}
+
+\helpref{SetBackgroundMode}{wxdcsetbackgroundmode}
+

 \membersection{wxDC::GetBrush}\label{wxdcgetbrush}
 
 \membersection{wxDC::GetBrush}\label{wxdcgetbrush}
 

-\func{wxBrush *}{GetBrush}{\void}
+\func{wxBrush\&}{GetBrush}{\void}
+
+\constfunc{const wxBrush\&}{GetBrush}{\void}

 
 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 
 \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight}
 
 
 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 
 \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight}
 

-\func{long}{GetCharHeight}{\void}
+\func{wxCoord}{GetCharHeight}{\void}

 
 Gets the character height of the currently set font.
 
 \membersection{wxDC::GetCharWidth}\label{wxdcgetcharwidth}
 
 
 Gets the character height of the currently set font.
 
 \membersection{wxDC::GetCharWidth}\label{wxdcgetcharwidth}
 

-\func{long}{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{wxCanvas::GetClippingBox}\label{wxdcgetclippingbox}
+\membersection{wxDC::GetClippingBox}\label{wxdcgetclippingbox}

 
 

-\func{void}{GetClippingBox}{\param{long}{ *x}, \param{long}{ *y}, \param{long}{ *width}, \param{long}{ *height}}
+\func{void}{GetClippingBox}{\param{wxCoord}{ *x}, \param{wxCoord}{ *y}, \param{wxCoord}{ *width}, \param{wxCoord}{ *height}}

 
 Gets the rectangle surrounding the current clipping region.
 
 
 Gets the rectangle surrounding the current clipping region.
 

+\pythonnote{No arguments are required and the four values defining the
+rectangle are returned as a tuple.}
+

 \membersection{wxDC::GetFont}\label{wxdcgetfont}
 
 \membersection{wxDC::GetFont}\label{wxdcgetfont}
 

-\func{wxFont *}{GetFont}{\void}
+\func{wxFont\&}{GetFont}{\void}
+
+\constfunc{const wxFont\&}{GetFont}{\void}

 
 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 
 
 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 


@@ -382,20 +462,25 @@ See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details.
 
 \membersection{wxDC::GetPen}\label{wxdcgetpen}
 
 
 \membersection{wxDC::GetPen}\label{wxdcgetpen}
 

-\func{wxPen *}{GetPen}{\void}
+\func{wxPen\&}{GetPen}{\void}
+
+\constfunc{const wxPen\&}{GetPen}{\void}

 
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}
 
 
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}
 

-\func{bool}{GetPixel}{\param{long}{ x}, \param{long}{ y}, \param{wxColour *}{colour}}
+\func{bool}{GetPixel}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}}

 
 Sets {\it colour} to the colour at the specified location. Windows only; an X implementation
 
 Sets {\it colour} to the colour at the specified location. Windows only; an X implementation

-is being worked on. Not available for wxPostScriptDC or wxMetaFileDC.
+is being worked on. Not available for wxPostScriptDC or wxMetafileDC.
+
+\pythonnote{For wxPython the wxColour value is returned and is not
+required as a parameter.}

 
 \membersection{wxDC::GetSize}\label{wxdcgetsize}
 
 
 \membersection{wxDC::GetSize}\label{wxdcgetsize}
 

-\func{void}{GetSize}{\param{long *}{width}, \param{long *}{height}}
+\func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}

 
 For a PostScript device context, this gets the maximum size of graphics
 drawn so far on the device context.
 
 For a PostScript device context, this gets the maximum size of graphics
 drawn so far on the device context.


@@ -408,23 +493,33 @@ application, the following code will scale the graphic to fit on the
 printer page:
 
 \begin{verbatim}
 printer page:
 
 \begin{verbatim}

-  long w, h;
+  wxCoord w, h;

   dc.GetSize(&w, &h);
   double scaleX=(double)(maxX/w);
   double scaleY=(double)(maxY/h);
   dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
 \end{verbatim}
 
   dc.GetSize(&w, &h);
   double scaleX=(double)(maxX/w);
   double scaleY=(double)(maxY/h);
   dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
 \end{verbatim}
 

+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetSize()}}{Returns a wxSize}
+\twocolitem{{\bf GetSizeTuple()}}{Returns a 2-tuple (width, height)}
+\end{twocollist}}
+}
+

 \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
 
 \func{wxColour\&}{GetTextBackground}{\void}
 
 \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
 
 \func{wxColour\&}{GetTextBackground}{\void}
 

+\constfunc{const wxColour\&}{GetTextBackground}{\void}
+

 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 
 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
 
 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 
 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
 

-\func{void}{GetTextExtent}{\param{const wxString\& }{string}, \param{long *}{w}, \param{long *}{h},\\
-  \param{long *}{descent = NULL}, \param{long *}{externalLeading = NULL}, \param{wxFont *}{font = NULL}}
+\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}}

 
 Gets the dimensions of the string using the currently selected font.
 \rtfsp{\it string} is the text string to measure, {\it w} and {\it h} are
 
 Gets the dimensions of the string using the currently selected font.
 \rtfsp{\it string} is the text string to measure, {\it w} and {\it h} are


@@ -440,61 +535,79 @@ the device context first.
 
 See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
 
 
 See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
 

+\pythonnote{The following methods are implemented in wxPython:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetTextExtent(string)}}{Returns a 2-tuple, (width, height)}
+\twocolitem{{\bf GetFullTextExtent(string, font=NULL)}}{Returns a
+4-tuple, (width, height, descent, externalLeading) }
+\end{twocollist}}
+}
+

 \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}
 
 \func{wxColour\&}{GetTextForeground}{\void}
 
 \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}
 
 \func{wxColour\&}{GetTextForeground}{\void}
 

+\constfunc{const wxColour\&}{GetTextForeground}{\void}
+

 Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}).
 
 Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}).
 

+
+\membersection{wxDC::GetUserScale}\label{wxdcgetuserscale}
+
+\func{void}{GetUserScale}{\param{double}{ *x}, \param{double}{ *y}}
+
+Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}).
+
+

 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 
 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 

-\func{long}{LogicalToDeviceX}{\param{long}{ x}}
+\func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}

 
 Converts logical X coordinate to device coordinate, using the current
 mapping mode.
 
 \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel}
 
 
 Converts logical X coordinate to device coordinate, using the current
 mapping mode.
 
 \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel}
 

-\func{long}{LogicalToDeviceXRel}{\param{long}{ x}}
+\func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}

 
 Converts logical X coordinate to relative device coordinate, using the current
 mapping mode. Use this for converting a width, for example.
 
 \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey}
 
 
 Converts logical X coordinate to relative device coordinate, using the current
 mapping mode. Use this for converting a width, for example.
 
 \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey}
 

-\func{long}{LogicalToDeviceY}{\param{long}{ y}}
+\func{wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}}

 
 Converts logical Y coordinate to device coordinate, using the current
 mapping mode.
 
 \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel}
 
 
 Converts logical Y coordinate to device coordinate, using the current
 mapping mode.
 
 \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel}
 

-\func{long}{LogicalToDeviceYRel}{\param{long}{ y}}
+\func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}

 
 Converts logical Y coordinate to relative device coordinate, using the current
 mapping mode. Use this for converting a height, for example.
 
 \membersection{wxDC::MaxX}\label{wxdcmaxx}
 
 
 Converts logical Y coordinate to relative device coordinate, using the current
 mapping mode. Use this for converting a height, for example.
 
 \membersection{wxDC::MaxX}\label{wxdcmaxx}
 

-\func{long}{MaxX}{\void}
+\func{wxCoord}{MaxX}{\void}

 
 Gets the maximum horizontal extent used in drawing commands so far.
 
 \membersection{wxDC::MaxY}\label{wxdcmaxy}
 
 
 Gets the maximum horizontal extent used in drawing commands so far.
 
 \membersection{wxDC::MaxY}\label{wxdcmaxy}
 

-\func{long}{MaxY}{\void}
+\func{wxCoord}{MaxY}{\void}

 
 Gets the maximum vertical extent used in drawing commands so far.
 
 \membersection{wxDC::MinX}\label{wxdcminx}
 
 
 Gets the maximum vertical extent used in drawing commands so far.
 
 \membersection{wxDC::MinX}\label{wxdcminx}
 

-\func{long}{MinX}{\void}
+\func{wxCoord}{MinX}{\void}

 
 Gets the minimum horizontal extent used in drawing commands so far.
 
 \membersection{wxDC::MinY}\label{wxdcminy}
 
 
 Gets the minimum horizontal extent used in drawing commands so far.
 
 \membersection{wxDC::MinY}\label{wxdcminy}
 

-\func{long}{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.
 


@@ -504,9 +617,20 @@ Gets the minimum vertical extent used in drawing commands so far.
 
 Returns TRUE if the DC is ok to use.
 
 
 Returns TRUE if the DC is ok to use.
 

+\membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox}
+
+\func{void}{ResetBoundingBox}{\void}
+
+Resets the bounding box: after a call to this function, the bounding box
+doesn't contain anything.
+
+\wxheading{See also}
+
+\helpref{CalcBoundingBox}{wxdccalcboundingbox}
+

 \membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
 
 \membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
 

-\func{void}{SetDeviceOrigin}{\param{long}{ x}, \param{long}{ y}}
+\func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}

 
 Sets the device origin (i.e., the origin in pixels after scaling has been
 applied).
 
 Sets the device origin (i.e., the origin in pixels after scaling has been
 applied).


@@ -529,19 +653,23 @@ whether text will be drawn with a background colour or not.
 
 \membersection{wxDC::SetClippingRegion}\label{wxdcsetclippingregion}
 
 
 \membersection{wxDC::SetClippingRegion}\label{wxdcsetclippingregion}
 

-\func{void}{SetClippingRegion}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
+\func{void}{SetClippingRegion}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxCoord}{ width}, \param{wxCoord}{ height}}
+
+\func{void}{SetClippingRegion}{\param{const wxRegion\&}{ region}}

 
 

-Sets the clipping region for the DC. The clipping region is a rectangular area
-to which drawing is restricted.  Possible uses for the clipping region are for clipping text
-or for speeding up canvas redraws when only a known area of the screen is damaged.
+Sets the clipping region for the DC. The clipping region is an area
+to which drawing is restricted. Possible uses for the clipping region are for clipping text
+or for speeding up window redraws when only a known area of the screen is damaged.
+
+\wxheading{See also}

 
 

-See also \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}.
+\helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}

 
 \membersection{wxDC::SetPalette}\label{wxdcsetpalette}
 
 \func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
 
 
 \membersection{wxDC::SetPalette}\label{wxdcsetpalette}
 
 \func{void}{SetPalette}{\param{const wxPalette\& }{palette}}
 

-If this is a canvas DC or memory DC, assigns the given palette to the window
+If this is a window DC or memory DC, assigns the given palette to the window

 or bitmap associated with the DC. If the argument is wxNullPalette, the current
 palette is selected out of the device context, and the original palette
 restored.
 or bitmap associated with the DC. If the argument is wxNullPalette, the current
 palette is selected out of the device context, and the original palette
 restored.


@@ -560,6 +688,9 @@ be destroyed safely.
 
 See also \helpref{wxBrush}{wxbrush}.
 
 
 See also \helpref{wxBrush}{wxbrush}.
 

+See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
+when drawing into a monochrome bitmap.
+

 \membersection{wxDC::SetFont}\label{wxdcsetfont}
 
 \func{void}{SetFont}{\param{const wxFont\& }{font}}
 \membersection{wxDC::SetFont}\label{wxdcsetfont}
 
 \func{void}{SetFont}{\param{const wxFont\& }{font}}


@@ -576,7 +707,7 @@ See also \helpref{wxFont}{wxfont}.
 
 \func{void}{SetLogicalFunction}{\param{int}{ function}}
 
 
 \func{void}{SetLogicalFunction}{\param{int}{ function}}
 

-Sets the current logical function for the canvas.  This determines how
+Sets the current logical function for the device context.  This determines how

 a source pixel (from a pen or brush colour, or source device context if
 using \helpref{wxDC::Blit}{wxdcblit}) combines with a destination pixel in the
 current device context.
 a source pixel (from a pen or brush colour, or source device context if
 using \helpref{wxDC::Blit}{wxdcblit}) combines with a destination pixel in the
 current device context.


@@ -606,7 +737,7 @@ wxXOR                 src XOR dst
 
 The default is wxCOPY, which simply draws with the current colour.
 The others combine the current colour and the background using a
 
 The default is wxCOPY, which simply draws with the current colour.
 The others combine the current colour and the background using a

-logical operation.  wxXOR is commonly used for drawing rubber bands or
+logical operation.  wxINVERT is commonly used for drawing rubber bands or

 moving outlines, since drawing twice reverts to the original colour.
 
 \membersection{wxDC::SetMapMode}\label{wxdcsetmapmode}
 moving outlines, since drawing twice reverts to the original colour.
 
 \membersection{wxDC::SetMapMode}\label{wxdcsetmapmode}


@@ -631,12 +762,12 @@ PostScript output.
 The mapping mode can be one of the following:
 
 \begin{twocollist}\itemsep=0pt
 The mapping mode can be one of the following:
 
 \begin{twocollist}\itemsep=0pt

-\twocolitem{MM\_TWIPS}{Each logical unit is 1/20 of a point, or 1/1440 of
+\twocolitem{wxMM\_TWIPS}{Each logical unit is 1/20 of a point, or 1/1440 of

   an inch.}
   an inch.}

-\twocolitem{MM\_POINTS}{Each logical unit is a point, or 1/72 of an inch.}
-\twocolitem{MM\_METRIC}{Each logical unit is 1 mm.}
-\twocolitem{MM\_LOMETRIC}{Each logical unit is 1/10 of a mm.}
-\twocolitem{MM\_TEXT}{Each logical unit is 1 pixel.}
+\twocolitem{wxMM\_POINTS}{Each logical unit is a point, or 1/72 of an inch.}
+\twocolitem{wxMM\_METRIC}{Each logical unit is 1 mm.}
+\twocolitem{wxMM\_LOMETRIC}{Each logical unit is 1/10 of a mm.}
+\twocolitem{wxMM\_TEXT}{Each logical unit is 1 pixel.}

 \end{twocollist}
 
 \membersection{wxDC::SetOptimization}\label{wxsetoptimization}
 \end{twocollist}
 
 \membersection{wxDC::SetOptimization}\label{wxsetoptimization}


@@ -662,6 +793,9 @@ 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.
 
 If the argument is wxNullPen, the current pen is selected out of the device
 context, and the original pen restored.
 

+See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
+when drawing into a monochrome bitmap.
+

 \membersection{wxDC::SetTextBackground}\label{wxdcsettextbackground}
 
 \func{void}{SetTextBackground}{\param{const wxColour\& }{colour}}
 \membersection{wxDC::SetTextBackground}\label{wxdcsettextbackground}
 
 \func{void}{SetTextBackground}{\param{const wxColour\& }{colour}}


@@ -674,6 +808,9 @@ Sets the current text background colour for the DC.
 
 Sets the current text foreground colour for the DC.
 
 
 Sets the current text foreground colour for the DC.
 

+See also \helpref{wxMemoryDC}{wxmemorydc} for the interpretation of colours
+when drawing into a monochrome bitmap.
+

 \membersection{wxDC::SetUserScale}\label{wxdcsetuserscale}
 
 \func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}}
 \membersection{wxDC::SetUserScale}\label{wxdcsetuserscale}
 
 \func{void}{SetUserScale}{\param{double}{ xScale}, \param{double}{ yScale}}