Added first batch of docs and notes for wxPython.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1726 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
1999-02-19 07:58:02 +00:00
parent 2e35f56f6d
commit 06d20283af
18 changed files with 787 additions and 15 deletions

View File

@@ -187,14 +187,14 @@ filling the shape.
\func{void}{DrawEllipticArc}{\param{long}{ x}, \param{long}{ y}, \param{long}{ width}, \param{long}{ height},
\param{double}{ start}, \param{double}{ end}}
Draws an arc of an ellipse. The current pen is used for drawing the arc and
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.
{\it x} and {\it y} specify the x and y coordinates of the upper-left corner of the rectangle that contains
the ellipse.
{\it width} and {\it height} specify the width and height of the rectangle that contains
{\it width} and {\it height} specify the width and height of the rectangle that contains
the ellipse.
{\it start} and {\it end} specify the start and end of the arc relative to the three-o'clock
@@ -228,6 +228,9 @@ 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.
\pythonnote{The wxPython version of this method accepts a Python list
of wxPoint objects.}
\membersection{wxDC::DrawPolygon}\label{wxdcdrawpolygon}
\func{void}{DrawPolygon}{\param{int}{ n}, \param{wxPoint}{ points[]}, \param{long}{ xoffset = 0}, \param{long}{ yoffset = 0},\\
@@ -248,6 +251,9 @@ The programmer is responsible for deleting the list of points.
Note that wxWindows automatically closes the first and last points.
\pythonnote{The wxPython version of this method accepts a Python list
of wxPoint objects.}
\membersection{wxDC::DrawPoint}\label{wxdcdrawpoint}
\func{void}{DrawPoint}{\param{long}{ x}, \param{long}{ y}}
@@ -292,6 +298,9 @@ program `XFIG'.
Draws a three-point spline using the current pen.
\pythonnote{The wxPython version of this method accepts a Python list
of wxPoint objects.}
\membersection{wxDC::DrawText}\label{wxdcdrawtext}
\func{void}{DrawText}{\param{const wxString\& }{text}, \param{long}{ x}, \param{long}{ y}}
@@ -368,6 +377,9 @@ Gets the average character width of the currently set font.
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.}
\membersection{wxDC::GetFont}\label{wxdcgetfont}
\func{wxFont\&}{GetFont}{\void}
@@ -428,6 +440,9 @@ printer page:
dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY));
\end{verbatim}
\pythonnote{No arguments are required and the two values defining the
size are returned as a tuple.}
\membersection{wxDC::GetTextBackground}\label{wxdcgettextbackground}
\func{wxColour\&}{GetTextBackground}{\void}
@@ -453,6 +468,14 @@ the device context first.
See also \helpref{wxFont}{wxfont}, \helpref{wxDC::SetFont}{wxdcsetfont}.
\pythonnote{The following methods are implemented in wxPython:\par
\indented{2cm}{\begin{twocollist}
\twocolitem{\bf{GetTextExtent(string)}}{Returns a 2-tuple, (width, height)}
\twocolitem{\bf{GetFullTextExtent(string, font=NULL)}}{Returns a
4-tuple, (width, height, descent, externalLeading) }
\end{twocollist}}
}
\membersection{wxDC::GetTextForeground}\label{wxdcgettextforeground}
\func{wxColour\&}{GetTextForeground}{\void}