no changes, just come cleanup and more comments

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

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index c8d929e22a64eac92ae8de2851beccf36bf107c6..a834277cf996694f10af86c35a2c1d152752e953 100644 (file)
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -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.
 
+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}
@@ -32,6 +38,10 @@ the color's alpha values when stroking or filling.
 
 <wx/dc.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{Overview}{dcoverview}
@@ -199,7 +209,7 @@ See also \helpref{wxDC::SetClippingRegion}{wxdcsetclippingregion}.
 
 \membersection{wxDC::DeviceToLogicalX}\label{wxdcdevicetologicalx}
 
-\func{wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}
+\func{virtual wxCoord}{DeviceToLogicalX}{\param{wxCoord}{ x}}
 
 Convert device X coordinate to logical coordinate, using the current
 mapping mode.
@@ -207,7 +217,7 @@ mapping mode.
 
 \membersection{wxDC::DeviceToLogicalXRel}\label{wxdcdevicetologicalxrel}
 
-\func{wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
+\func{virtual wxCoord}{DeviceToLogicalXRel}{\param{wxCoord}{ x}}
 
 Convert device X coordinate to relative logical coordinate, using the current
 mapping mode but ignoring the x axis orientation.
@@ -216,7 +226,7 @@ Use this function for converting a width, for example.
 
 \membersection{wxDC::DeviceToLogicalY}\label{wxdcdevicetologicaly}
 
-\func{wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}}
+\func{virtual wxCoord}{DeviceToLogicalY}{\param{wxCoord}{ y}}
 
 Converts device Y coordinate to logical coordinate, using the current
 mapping mode.
@@ -224,7 +234,7 @@ mapping mode.
 
 \membersection{wxDC::DeviceToLogicalYRel}\label{wxdcdevicetologicalyrel}
 
-\func{wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
+\func{virtual wxCoord}{DeviceToLogicalYRel}{\param{wxCoord}{ y}}
 
 Convert device Y coordinate to relative logical coordinate, using the current
 mapping mode but ignoring the y axis orientation.
@@ -355,12 +365,15 @@ of many other toolkits).
 
 \func{void}{DrawLines}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
 
-\func{void}{DrawLines}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
+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.
+
+\func{void}{DrawLines}{\param{const wxPointList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0}}
 
-Draws lines using an array of {\it points} of size {\it n}, or list of
-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.
+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.}
@@ -375,11 +388,14 @@ of wxPoint objects.}
 \func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 
-\func{void}{DrawPolygon}{\param{wxList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
+Draws a filled polygon using an array of {\it points} of size {\it n},
+adding the optional offset coordinate.
+
+\func{void}{DrawPolygon}{\param{const wxPointList *}{points}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
   \param{int }{fill\_style = wxODDEVEN\_RULE}}
 
-Draws a filled polygon using an array of {\it points} of size {\it n},
-or list of pointers to points, 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}.
@@ -487,10 +503,9 @@ the rectangle.
 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}}
 
@@ -624,6 +639,17 @@ rectangle are returned as a tuple.}
 {\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}
@@ -880,7 +906,7 @@ use \arg{initialColour} on the left part of the rectangle and
 
 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 
-\func{wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}
+\func{virtual wxCoord}{LogicalToDeviceX}{\param{wxCoord}{ x}}
 
 Converts logical X coordinate to device coordinate, using the current
 mapping mode.
@@ -888,7 +914,7 @@ mapping mode.
 
 \membersection{wxDC::LogicalToDeviceXRel}\label{wxdclogicaltodevicexrel}
 
-\func{wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
+\func{virtual wxCoord}{LogicalToDeviceXRel}{\param{wxCoord}{ x}}
 
 Converts logical X coordinate to relative device coordinate, using the current
 mapping mode but ignoring the x axis orientation.
@@ -897,7 +923,7 @@ Use this for converting a width, for example.
 
 \membersection{wxDC::LogicalToDeviceY}\label{wxdclogicaltodevicey}
 
-\func{wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}}
+\func{virtual wxCoord}{LogicalToDeviceY}{\param{wxCoord}{ y}}
 
 Converts logical Y coordinate to device coordinate, using the current
 mapping mode.
@@ -905,7 +931,7 @@ mapping mode.
 
 \membersection{wxDC::LogicalToDeviceYRel}\label{wxdclogicaltodeviceyrel}
 
-\func{wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
+\func{virtual wxCoord}{LogicalToDeviceYRel}{\param{wxCoord}{ y}}
 
 Converts logical Y coordinate to relative device coordinate, using the current
 mapping mode but ignoring the y axis orientation.
@@ -1129,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\_TEXT}{Each logical unit is 1 pixel.}
+\twocolitem{wxMM\_TEXT}{Each logical unit is 1 device pixel.}
 \end{twocollist}
 
 
@@ -1142,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.
 
-See \helpref{wxPalette}{wxpalette} for further details. 
+See \helpref{wxPalette}{wxpalette} for further details.
 
 
 \membersection{wxDC::SetPen}\label{wxdcsetpen}