CW5.2 Pro Adaptions, wxMac starting to move in

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

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index eddddcd335a17dc789f41f309e39d9697dbd8be9..99d110b092fa49c23ad461d00320d49e24c214ae 100644 (file)
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -13,6 +13,10 @@ only, so refer to this section for most device context information.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/dc.h>
+
 \wxheading{See also}
 
 \helpref{Overview}{dcoverview}
@@ -49,8 +53,8 @@ released for each drawing operation.
 \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}}
+  \param{wxDC* }{source}, \param{long}{ xsrc}, \param{long}{ 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
@@ -100,7 +104,7 @@ There is partial support for Blit in wxPostScriptDC, under X.
 
 See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
 
-wxheading{See also}
+\wxheading{See also}
 
 \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
 
@@ -163,6 +167,13 @@ 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{long}{ x}, \param{long}{ 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.
+
 \membersection{wxDC::DrawEllipse}\label{wxdcdrawellipse}
 
 \func{void}{DrawEllipse}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
@@ -176,14 +187,14 @@ filling the shape.
 \func{void}{DrawEllipticArc}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height},
  \param{double}{ start}, \param{double}{ end}}
 
-Draws an arc of an ellipse. The current pen is used for drawing the arc and 
+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 window and PostScript device contexts.
 
 {\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
@@ -217,6 +228,9 @@ 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}
 
 \func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0},\\
@@ -237,6 +251,9 @@ The programmer is responsible for deleting the list of 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}
 
 \func{void}{DrawPoint}{\param{long}{ x}, \param{long}{ y}}
@@ -281,6 +298,9 @@ program `XFIG'.
 
 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}
 
 \func{void}{DrawText}{\param{const wxString\& }{text}, \param{long}{ x}, \param{long}{ y}}
@@ -357,6 +377,9 @@ Gets the average character width of the currently set font.
 
 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}
 
 \func{wxFont\&}{GetFont}{\void}
@@ -393,7 +416,10 @@ Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 \func{bool}{GetPixel}{\param{long}{ x}, \param{long}{ y}, \param{wxColour *}{colour}}
 
 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}
 
@@ -417,6 +443,14 @@ printer page:
   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}
@@ -442,6 +476,14 @@ the device context first.
 
 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}
@@ -612,7 +654,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
-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}
@@ -637,12 +679,12 @@ PostScript output.
 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.}
-\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}