1. wxDataObject compilation fixes (can't test if it works right now, sorry)

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

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index ecbf200c0bffc6bd0b08bb802f6e646e8fe5bb58..521cafa5b0ce2b2dfc7a0890123400a9f249da74 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}
@@ -183,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
@@ -224,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},\\
@@ -244,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}}
@@ -288,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}}
@@ -364,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}
@@ -400,7 +416,7 @@ 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.
 
 \membersection{wxDC::GetSize}\label{wxdcgetsize}
 
@@ -424,6 +440,9 @@ printer page:
   dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
 \end{verbatim}
 
+\pythonnote{No arguments are required and the two values defining the
+size are returned as a tuple.}
+
 \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
 
 \func{wxColour\&}{GetTextBackground}{\void}
@@ -449,6 +468,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}
@@ -644,12 +671,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}