]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dc.tex
Cured some small doc typos; some WIN16 fixes; transferred DLL WinMain to
[wxWidgets.git] / docs / latex / wx / dc.tex
index 333d6355b7d6635e5a4d35002cd7a6e7a39964c1..26aa80fc9aceff8f6f9637ef6ee59d476eb208c6 100644 (file)
@@ -163,6 +163,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}}
@@ -329,13 +336,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}).
 
@@ -359,7 +366,7 @@ Gets the rectangle surrounding the current clipping region.
 
 \membersection{wxDC::GetFont}\label{wxdcgetfont}
 
-\func{wxFont *}{GetFont}{\void}
+\func{wxFont\&}{GetFont}{\void}
 
 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 
@@ -384,7 +391,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}).
 
@@ -393,7 +400,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}
 
@@ -533,11 +540,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}
 
@@ -633,12 +644,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}