replaced my recent GSocket_SetReuseAddr() addition with GSocket_SetReusable() from...

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

diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex
index 361ab2f26c669a011de5eeb5e0daf1977f12051a..8d356c420833b4c88aa98cdebddbbc4224c11df1 100644 (file)
--- a/docs/latex/wx/pen.tex
+++ b/docs/latex/wx/pen.tex
@@ -34,7 +34,7 @@ wxLIGHT\_GREY\_PEN}
 
 \wxheading{Remarks}
 
-On a monochrome display, wxWindows shows all non-white pens as black.
+On a monochrome display, wxWidgets shows all non-white pens as black.
 
 Do not initialize objects on the stack before the program commences,
 since other required structures may not have been set up yet. Instead,
@@ -66,9 +66,9 @@ 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}}
+\func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{int}{ width = $1$}, \param{int}{ style = {\tt wxSOLID}}}
 
 Constructs a pen from a colour object, pen width and 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}
@@ -145,7 +151,7 @@ system, since wxBrush uses a reference counting system for efficiency.
 
 Although all remaining pens are deleted when the application exits,
 the application should try to clean up all pens itself. This is because
-wxWindows cannot know if a pointer to the pen object is stored in an
+wxWidgets cannot know if a pointer to the pen object is stored in an
 application data structure, and there is a risk of double deletion.
 
 \membersection{wxPen::GetCap}\label{wxpengetcap}
@@ -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}
 
@@ -269,7 +275,7 @@ function is called with a NULL array.
 
 \membersection{wxPen::SetJoin}\label{wxpensetjoin}
 
-\func{void}{SetJoin}{\param{int}{join\_style}}
+\func{void}{SetJoin}{\param{int }{join\_style}}
 
 Sets the pen join style, which may be one of {\bf wxJOIN\_BEVEL}, {\bf wxJOIN\_ROUND} and
 \rtfsp{\bf wxJOIN\_MITER}. The default is {\bf wxJOIN\_ROUND}.
@@ -342,7 +348,7 @@ be deleted and their resources freed, eliminating the possibility of
 `memory leaks'. However, it is best not to rely on this automatic
 cleanup because it can lead to double deletion in some circumstances.
 
-There are two mechanisms in recent versions of wxWindows which make the
+There are two mechanisms in recent versions of wxWidgets which make the
 pen list less useful than it once was. Under Windows, scarce resources
 are cleaned up internally if they are not being used. Also, a referencing
 counting mechanism applied to all GDI objects means that some sharing
@@ -356,9 +362,9 @@ and copy pens as you see fit. If your Windows resource meter suggests
 your application is using too many resources, you can resort to using
 GDI lists to share objects explicitly.
 
-The only compelling use for the pen list is for wxWindows to keep
+The only compelling use for the pen list is for wxWidgets to keep
 track of pens in order to clean them up on exit. It is also kept for
-backward compatibility with earlier versions of wxWindows.
+backward compatibility with earlier versions of wxWidgets.
 
 \wxheading{See also}
 
@@ -377,7 +383,7 @@ use the object pointer {\bf wxThePenList}.
 
 \func{void}{AddPen}{\param{wxPen*}{ pen}}
 
-Used internally by wxWindows to add a pen to the list.
+Used internally by wxWidgets to add a pen to the list.
 
 \membersection{wxPenList::FindOrCreatePen}\label{wxpenlistfindorcreatepen}
 
@@ -405,6 +411,6 @@ to the pen list, and returns it.
 
 \func{void}{RemovePen}{\param{wxPen*}{ pen}}
 
-Used by wxWindows to remove a pen from the list.
+Used by wxWidgets to remove a pen from the list.