]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dc.tex
no changes, just come cleanup and more comments
[wxWidgets.git] / docs / latex / wx / dc.tex
index fbb5a427d451b9e84ebb6564f3fe399c412d17a1..a834277cf996694f10af86c35a2c1d152752e953 100644 (file)
@@ -24,6 +24,12 @@ On Mac OS X when using Core Graphics (wx\_MAC\_USE\_CORE\_GRAPHICS set to 1)
 colors with alpha are supported, so instances  {\tt wxPen} or  {\tt wxBrush} that are built from  {\tt wxColour} use
 the color's alpha values when stroking or filling.
 
 colors with alpha are supported, so instances  {\tt wxPen} or  {\tt wxBrush} that are built from  {\tt wxColour} use
 the color's alpha values when stroking or filling.
 
+Note that beginning with wxWidgets 2.9.0 the entire wxDC code has been
+reorganized. All platform dependent code (actual all drawing code) has
+been moved into backend classes which derive from a common wxDCImpl
+class. The user-visible classes such as wxClientDC and wxPaintDC
+merely forward all calls to the backend implementation.
+
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
@@ -363,12 +369,11 @@ Draws lines using an array of {\it points} of size {\it n}
 adding the optional offset coordinate. The current pen is
 used for drawing the lines.
 
 adding the optional offset coordinate. The current pen is
 used for drawing the lines.
 
-\func{void}{DrawLines}{\param{const wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
+\func{void}{DrawLines}{\param{const wxPointList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
 
 
-This method is deprecated and will be removed or replaced
-with a type-safe version. It uses a wxList of pointers to
-wxPoints, adding the optional offset coordinate. The programmer
-is responsible for deleting the list of points.
+This method uses a list of wxPoints, adding the optional offset
+coordinate. The programmer is responsible for deleting the list
+of points.
 
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}
 
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}
@@ -386,13 +391,11 @@ of wxPoint objects.}
 Draws a filled polygon using an array of {\it points} of size {\it n},
 adding the optional offset coordinate.
 
 Draws a filled polygon using an array of {\it points} of size {\it n},
 adding the optional offset coordinate.
 
-\func{void}{DrawPolygon}{\param{const wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
+\func{void}{DrawPolygon}{\param{const wxPointList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 
   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 
-This method is deprecated and will be removed or replaced
-with a type-safe version. It draws a filled polygon using
-a list of pointers to wxPoints, adding  the optional offset
-coordinate.
+This method draws a filled polygon using a list of wxPoints,
+adding the optional offset coordinate.
 
 The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the
 default) or {\bf wxWINDING\_RULE}.
 
 The last argument specifies the fill rule: {\bf wxODDEVEN\_RULE} (the
 default) or {\bf wxWINDING\_RULE}.
@@ -500,10 +503,9 @@ the rectangle.
 Draws a spline between all given control points, using the current
 pen.
 
 Draws a spline between all given control points, using the current
 pen.
 
-\func{void}{DrawSpline}{\param{wxList *}{points}}
+\func{void}{DrawSpline}{\param{const wxPointList *}{points}}
 
 
-Draws a spline between all given control points, using the current
-pen.  Doesn't delete the wxList and contents.
+Draws a spline between all given control points.
 
 \func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}}
 
 
 \func{void}{DrawSpline}{\param{wxCoord}{ x1}, \param{wxCoord}{ y1}, \param{wxCoord}{ x2}, \param{wxCoord}{ y2}, \param{wxCoord}{ x3}, \param{wxCoord}{ y3}}
 
@@ -637,6 +639,17 @@ rectangle are returned as a tuple.}
 {\tt ( x, y, width, height )}}
 
 
 {\tt ( x, y, width, height )}}
 
 
+\membersection{wxDC::GetDepth}\label{wxdcgetdepth}
+
+\constfunc{int}{GetDepth}{\void}
+
+Returns the depth (number of bits/pixel) of this DC.
+
+\wxheading{See also}
+
+\helpref{wxDisplayDepth}{wxdisplaydepth}
+
+
 \membersection{wxDC::GetFont}\label{wxdcgetfont}
 
 \constfunc{const wxFont\&}{GetFont}{\void}
 \membersection{wxDC::GetFont}\label{wxdcgetfont}
 
 \constfunc{const wxFont\&}{GetFont}{\void}
@@ -1142,7 +1155,7 @@ The mapping mode can be one of the following:
 \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\_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.}
+\twocolitem{wxMM\_TEXT}{Each logical unit is 1 device pixel.}
 \end{twocollist}
 
 
 \end{twocollist}
 
 
@@ -1155,7 +1168,7 @@ 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.
 
 palette is selected out of the device context, and the original palette
 restored.
 
-See \helpref{wxPalette}{wxpalette} for further details. 
+See \helpref{wxPalette}{wxpalette} for further details.
 
 
 \membersection{wxDC::SetPen}\label{wxdcsetpen}
 
 
 \membersection{wxDC::SetPen}\label{wxdcsetpen}