X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fa482912e420a40e9f2e55a0f5407562826dd15e..bf7945cef10c0844a32e95695c544d829da9293a:/docs/latex/wx/dc.tex

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index a7ccf42499..a090adaae7 100644
--- a/docs/latex/wx/dc.tex
+++ b/docs/latex/wx/dc.tex
@@ -9,6 +9,13 @@ if the device context is used as a parameter.
 Derived types of wxDC have documentation for specific features
 only, so refer to this section for most device context information.
 
+% VZ: we should really document them instead of this lame excuse, but I don't
+%     have time for it now, when it is done please remove this
+Please note that in addition to the versions of the methods documented here,
+there are also versions which accept single {\tt wxPoint} parameter instead of
+two {\tt wxCoord} ones or {\tt wxPoint} and {\tt wxSize} instead of four of
+them.
+
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
@@ -108,6 +115,18 @@ See \helpref{wxMemoryDC}{wxmemorydc} for typical usage.
 
 \helpref{wxMemoryDC}{wxmemorydc}, \helpref{wxBitmap}{wxbitmap}, \helpref{wxMask}{wxmask}
 
+\membersection{wxDC::CalcBoundingBox}\label{wxdccalcboundingbox}
+
+\func{void}{CalcBoundingBox}{\param{wxCoord }{x}, \param{wxCoord }{y}}
+
+Adds the specified point to the bounding box which can be retrieved with 
+\helpref{MinX}{wxdcminx}, \helpref{MaxX}{wxdcmaxx} and 
+\helpref{MinY}{wxdcminy}, \helpref{MaxY}{wxdcmaxy} functions.
+
+\wxheading{See also}
+
+\helpref{ResetBoundingBox}{wxdcresetboundingbox}
+
 \membersection{wxDC::Clear}\label{wxdcclear}
 
 \func{void}{Clear}{\void}
@@ -201,8 +220,7 @@ filling the shape.
  \param{double}{ start}, \param{double}{ end}}
 
 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.
+the current brush is used for drawing the pie.
 
 {\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
 the ellipse.
@@ -244,6 +262,10 @@ deleting the list of points.
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}
 
+\perlnote{The wxPerl version of this method accepts 
+  as its first parameter a reference to an array
+  of wxPoint objects.}
+
 \membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
 
 \func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{wxCoord}{ xoffset = 0}, \param{wxCoord}{ yoffset = 0},\\
@@ -267,6 +289,10 @@ Note that wxWindows automatically closes the first and last points.
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}
 
+\perlnote{The wxPerl version of this method accepts 
+  as its first parameter a reference to an array
+  of wxPoint objects.}
+
 \membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
 
 \func{void}{DrawPoint}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}
@@ -324,6 +350,9 @@ Draws a three-point spline using the current pen.
 \pythonnote{The wxPython version of this method accepts a Python list
 of wxPoint objects.}
 
+\perlnote{The wxPerl version of this method accepts a reference to an array
+  of wxPoint objects.}
+
 \membersection{wxDC::DrawText}\label{wxdcdrawtext}
 
 \func{void}{DrawText}{\param{const wxString\& }{text}, \param{wxCoord}{ x}, \param{wxCoord}{ y}}
@@ -336,6 +365,11 @@ the string. See \helpref{wxDC::GetTextExtent}{wxdcgettextextent} for how
 to get the dimensions of a text string, which can be used to position the
 text more precisely.
 
+{\bf NB:} under wxGTK the current 
+\helpref{logical function}{wxdcgetlogicalfunction} is used by this function
+but it is ignored by wxMSW. Thus, you should avoid using logical functions
+with this function in portable programs.
+
 \membersection{wxDC::EndDoc}\label{wxdcenddoc}
 
 \func{void}{EndDoc}{\void}
@@ -358,10 +392,10 @@ Ends a document page (only relevant when outputting to a printer).
 
 \membersection{wxDC::FloodFill}\label{wxdcfloodfill}
 
-\func{void}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{wxColour *}{colour}, \param{int}{ style=wxFLOOD\_SURFACE}}
+\func{void}{FloodFill}{\param{wxCoord}{ x}, \param{wxCoord}{ y}, \param{const wxColour\&}{ colour}, \param{int}{ style=wxFLOOD\_SURFACE}}
 
-Flood fills the device context starting from the given point, in the given colour,
-and using a style:
+Flood fills the device context starting from the given point, using
+the {\it current brush colour}, and using a style:
 
 \begin{itemize}\itemsep=0pt
 \item wxFLOOD\_SURFACE: the flooding occurs until a colour other than the given colour is encountered.
@@ -374,12 +408,26 @@ and using a style:
 
 \func{wxBrush\&}{GetBackground}{\void}
 
+\constfunc{const wxBrush\&}{GetBackground}{\void}
+
 Gets the brush used for painting the background (see \helpref{wxDC::SetBackground}{wxdcsetbackground}).
 
+\membersection{wxDC::GetBackgroundMode}\label{wxdcgetbackgroundmode}
+
+\constfunc{int}{GetBackgroundMode}{\void}
+
+Returns the current background mode: {\tt wxSOLID} or {\tt wxTRANSPARENT}.
+
+\wxheading{See also}
+
+\helpref{SetBackgroundMode}{wxdcsetbackgroundmode}
+
 \membersection{wxDC::GetBrush}\label{wxdcgetbrush}
 
 \func{wxBrush\&}{GetBrush}{\void}
 
+\constfunc{const wxBrush\&}{GetBrush}{\void}
+
 Gets the current brush (see \helpref{wxDC::SetBrush}{wxdcsetbrush}).
 
 \membersection{wxDC::GetCharHeight}\label{wxdcgetcharheight}
@@ -403,10 +451,15 @@ 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.}
 
+\perlnote{This method takes no arguments and returns a four element list
+{\tt ( \$x, \$y, \$width, \$height )}}
+
 \membersection{wxDC::GetFont}\label{wxdcgetfont}
 
 \func{wxFont\&}{GetFont}{\void}
 
+\constfunc{const wxFont\&}{GetFont}{\void}
+
 Gets the current font (see \helpref{wxDC::SetFont}{wxdcsetfont}).
 
 \membersection{wxDC::GetLogicalFunction}\label{wxdcgetlogicalfunction}
@@ -432,6 +485,8 @@ See \helpref{wxDC::SetOptimization}{wxsetoptimization} for details.
 
 \func{wxPen\&}{GetPen}{\void}
 
+\constfunc{const wxPen\&}{GetPen}{\void}
+
 Gets the current pen (see \helpref{wxDC::SetPen}{wxdcsetpen}).
 
 \membersection{wxDC::GetPixel}\label{wxdcgetpixel}
@@ -444,6 +499,9 @@ is being worked on. Not available for wxPostScriptDC or wxMetafileDC.
 \pythonnote{For wxPython the wxColour value is returned and is not
 required as a parameter.}
 
+\perlnote{This method only takes the parameters {\tt x} and {\tt y} and returns
+a Wx::Colour value}
+
 \membersection{wxDC::GetSize}\label{wxdcgetsize}
 
 \func{void}{GetSize}{\param{wxCoord *}{width}, \param{wxCoord *}{height}}
@@ -474,10 +532,20 @@ implements the following methods:\par
 \end{twocollist}}
 }
 
+\perlnote{In place of a single overloaded method, wxPerl uses:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf GetSize()}}{Returns a Wx::Size}
+\twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list
+  {\tt ( \$width, \$height )}}
+\end{twocollist}
+}}
+
 \membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
 
 \func{wxColour\&}{GetTextBackground}{\void}
 
+\constfunc{const wxColour\&}{GetTextBackground}{\void}
+
 Gets the current text background colour (see \helpref{wxDC::SetTextBackground}{wxdcsettextbackground}).
 
 \membersection{wxDC::GetTextExtent}\label{wxdcgettextextent}
@@ -507,10 +575,17 @@ See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
 \end{twocollist}}
 }
 
+\perlnote{In wxPerl this method is implemented as 
+  {\bf GetTextExtent( string, font = undef )} returning a four element
+  array {\tt ( \$width, \$height, \$descent, \$externalLeading )}
+}
+
 \membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}
 
 \func{wxColour\&}{GetTextForeground}{\void}
 
+\constfunc{const wxColour\&}{GetTextForeground}{\void}
+
 Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{wxdcsettextforeground}).
 
 
@@ -520,6 +595,8 @@ Gets the current text foreground colour (see \helpref{wxDC::SetTextForeground}{w
 
 Gets the current user scale factor (set by \helpref{SetUserScale}{wxdcsetuserscale}).
 
+\perlnote{In wxPerl this method takes no arguments and returna a two element
+ array {\tt ( \$x, \$y )}}
 
 \membersection{wxDC::LogicalToDeviceX}\label{wxdclogicaltodevicex}
 
@@ -579,6 +656,17 @@ Gets the minimum vertical extent used in drawing commands so far.
 
 Returns TRUE if the DC is ok to use.
 
+\membersection{wxDC::ResetBoundingBox}\label{wxdcresetboundingbox}
+
+\func{void}{ResetBoundingBox}{\void}
+
+Resets the bounding box: after a call to this function, the bounding box
+doesn't contain anything.
+
+\wxheading{See also}
+
+\helpref{CalcBoundingBox}{wxdccalcboundingbox}
+
 \membersection{wxDC::SetDeviceOrigin}\label{wxdcsetdeviceorigin}
 
 \func{void}{SetDeviceOrigin}{\param{wxCoord}{ x}, \param{wxCoord}{ y}}