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 a4d71bd80a3e9b12a96bb581ce59698e1bfce33d..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}
@@ -157,10 +161,19 @@ mapping mode. Use this function for converting a height, for example.
 
 \func{void}{DrawArc}{\param{long}{ x1}, \param{long}{ y1}, \param{long}{ x2}, \param{long}{ 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.
 
+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}}
@@ -174,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
@@ -215,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},\\
@@ -235,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}}
@@ -279,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}}
@@ -327,13 +349,13 @@ and using a style:
 
 \membersection{wxDC::GetBackground}\label{wxdcgetbackground}
 
-\func{wxBrush *}{GetBackground}{\void}
+\func{wxBrush\&}{GetBackground}{\void}
 
 Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}).
 
 \membersection{wxDC::GetBrush}\label{wxdcgetbrush}
 
-\func{wxBrush *}{GetBrush}{\void}
+\func{wxBrush\&}{GetBrush}{\void}
 
 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 
@@ -355,9 +377,12 @@ 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}
+\func{wxFont\&}{GetFont}{\void}
 
 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 
@@ -382,7 +407,7 @@ See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details.
 
 \membersection{wxDC::GetPen}\label{wxdcgetpen}
 
-\func{wxPen *}{GetPen}{\void}
+\func{wxPen\&}{GetPen}{\void}
 
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
@@ -391,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}
 
@@ -415,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}
@@ -440,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}
@@ -531,11 +567,15 @@ whether text will be drawn with a background colour or not.
 
 \func{void}{SetClippingRegion}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height}}
 
-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
+\func{void}{SetClippingRegion}{\param{const wxRegion\&}{ region}}
+
+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.
 
-See also \helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}.
+\wxheading{See also}
+
+\helpref{wxDC::DestroyClippingRegion}{wxdcdestroyclippingregion}, \helpref{wxRegion}{wxregion}
 
 \membersection{wxDC::SetPalette}\label{wxdcsetpalette}
 
@@ -631,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}