Added EVT_GRID_EDITOR_CREATED and wxGridEditorCreatedEvent so the user

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

diff --git a/docs/latex/wx/dc.tex b/docs/latex/wx/dc.tex
index 56a89cfbb92d98e856c87fb8f39b513db29125f4..a090adaae7d337ebd5109cbbfc97da1d2a21d404 100644 (file)
--- 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}
@@ -213,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.
@@ -256,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},\\
@@ -279,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}}
@@ -336,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}}
@@ -434,6 +451,9 @@ 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}
@@ -479,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}}
@@ -509,6 +532,14 @@ 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}
@@ -544,6 +575,11 @@ 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}
@@ -559,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}