Added missing 'break' which caused spurious </FONT></TD> markup before

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

diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex
index 67f449b884b20b5e584ff30d6fb16a496e4926d1..5a79e8f523cc23f11230d9afa759fadec2d3fa44 100644 (file)
--- a/docs/latex/wx/pen.tex
+++ b/docs/latex/wx/pen.tex
@@ -4,6 +4,34 @@ A pen is a drawing tool for drawing outlines. It is used for drawing
 lines and painting the outline of rectangles, ellipses, etc. It has a
 colour, a width and a style. 
 
+\wxheading{Derived from}
+
+\helpref{wxGDIObject}{wxgdiobject}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/pen.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullPen}
+
+Pointers:
+
+{\bf wxRED\_PEN\\
+wxCYAN\_PEN\\
+wxGREEN\_PEN\\
+wxBLACK\_PEN\\
+wxWHITE\_PEN\\
+wxTRANSPARENT\_PEN\\
+wxBLACK\_DASHED\_PEN\\
+wxGREY\_PEN\\
+wxMEDIUM\_GREY\_PEN\\
+wxLIGHT\_GREY\_PEN}
+
 \wxheading{Remarks}
 
 On a monochrome display, wxWindows shows all non-white pens as black.
@@ -69,9 +97,6 @@ the style is wxDOT, wxLONG\_DASH, wxSHORT\_DASH, wxDOT\_DASH, or wxUSER\_DASH.}
 
 \docparam{pen}{A pointer or reference to a pen to copy.}
 
-\docparam{width}{Pen width. Under Windows, the pen width cannot be greater than 1 if
-the style is wxDOT, wxLONG\_DASH, wxSHORT\_DASH, wxDOT\_DASH, or wxUSER\_DASH.}
-  
 \docparam{style}{The style may be one of the following:
 
 \begin{twocollist}\itemsep=0pt
@@ -93,17 +118,26 @@ the style is wxDOT, wxLONG\_DASH, wxSHORT\_DASH, wxDOT\_DASH, or wxUSER\_DASH.}
 
 \wxheading{Remarks}
 
+Different versions of Windows and different versions of other platforms
+support {\it very} different subsets of the styles above - there is no
+similarity even between Windows95 and Windows98 - so handle with care.
+
 If the named colour form is used, an appropriate {\bf wxColour} structure
 is found in the colour database.
 
-{\it style} may be one of wxSOLID, wxDOT, wxLONG\_DASH, wxSHORT\_DASH and
-wxDOT\_DASH.
-
 \wxheading{See also}
 
 \helpref{wxPen::SetStyle}{wxpensetstyle}, \helpref{wxPen::SetColour}{wxpensetcolour},\rtfsp
 \helpref{wxPen::SetWidth}{wxpensetwidth}, \helpref{wxPen::SetStipple}{wxpensetstipple}
 
+\perlnote{Constructors supported by wxPerl are:\par
+\begin{itemize}
+\item{Wx::Pen->new( colour, width, style )}
+\item{Wx::Pen->new( colourName, width, style )}
+\item{Wx::Pen->new( stipple, width )}
+\end{itemize}
+}
+
 \membersection{wxPen::\destruct{wxPen}}
 
 \func{}{\destruct{wxPen}}{\void}
@@ -367,7 +401,9 @@ to the pen list, and returns it.
 
 \docparam{colour}{Colour object.}
 
-\docparam{colourName}{Colour name, which should be in the colour database.}
+\docparam{colourName}{Colour name, which should be in the \helpref{colour database}{wxcolourdatabase}.}
+
+\docparam{width}{Width of pen.}
 
 \docparam{style}{Pen style. See \helpref{wxPen::wxPen}{wxpenconstr} for a list of styles.}