X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/20e85460c40ebc4dcc9577928771adb264cc998f..520200fd10b80c1d759311ed345789f5fe048ca5:/docs/latex/wx/pen.tex diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex index 361ab2f26c..86516c0081 100644 --- a/docs/latex/wx/pen.tex +++ b/docs/latex/wx/pen.tex @@ -66,7 +66,7 @@ data using the reference counting, are not affected. \func{}{wxPen}{\void} Default constructor. The pen will be uninitialised, and \helpref{wxPen::Ok}{wxpenok} will -return FALSE. +return false. \func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{int}{ width}, \param{int}{ style}} @@ -97,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 @@ -121,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} @@ -226,7 +232,7 @@ Returns the pen width. \constfunc{bool}{Ok}{\void} -Returns TRUE if the pen is initialised. +Returns true if the pen is initialised. \membersection{wxPen::SetCap}\label{wxpensetcap}