Fix underscore escaping again (one obscure one left in wxmsw.tex)

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

diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex
index 04dfafb1bf67e5f30cdc1e072cfd712d81ba9711..ae9677b3ba17bac9095fb9dd36f42e5adbc778a7 100644 (file)
--- a/docs/latex/wx/pen.tex
+++ b/docs/latex/wx/pen.tex
@@ -1,8 +1,19 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        pen.tex
+%% Purpose:     wxPen docs
+%% Author:
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+

 \section{\class{wxPen}}\label{wxpen}
 
 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
 \section{\class{wxPen}}\label{wxpen}
 
 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. 
+colour, a width and a style.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -34,7 +45,7 @@ wxLIGHT\_GREY\_PEN}
 
 \wxheading{Remarks}
 
 
 \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,
 
 Do not initialize objects on the stack before the program commences,
 since other required structures may not have been set up yet. Instead,


@@ -61,7 +72,7 @@ data using the reference counting, are not affected.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxPen::wxPen}\label{wxpenconstr}
+\membersection{wxPen::wxPen}\label{wxpenctor}

 
 \func{}{wxPen}{\void}
 
 
 \func{}{wxPen}{\void}
 


@@ -138,7 +149,7 @@ is found in the colour database.
 \end{itemize}
 }
 
 \end{itemize}
 }
 

-\membersection{wxPen::\destruct{wxPen}}
+\membersection{wxPen::\destruct{wxPen}}\label{wxpendtor}

 
 \func{}{\destruct{wxPen}}{\void}
 
 
 \func{}{\destruct{wxPen}}{\void}
 


@@ -151,7 +162,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
 
 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}
 application data structure, and there is a risk of double deletion.
 
 \membersection{wxPen::GetCap}\label{wxpengetcap}


@@ -216,7 +227,7 @@ Returns the pen style.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxPen::wxPen}{wxpenconstr}, \helpref{wxPen::SetStyle}{wxpensetstyle}
+\helpref{wxPen::wxPen}{wxpenctor}, \helpref{wxPen::SetStyle}{wxpensetstyle}

 
 \membersection{wxPen::GetWidth}\label{wxpengetwidth}
 
 
 \membersection{wxPen::GetWidth}\label{wxpengetwidth}
 


@@ -251,7 +262,7 @@ Sets the pen cap style, which may be one of {\bf wxCAP\_ROUND}, {\bf wxCAP\_PROJ
 
 \func{void}{SetColour}{\param{const wxString\& }{colourName}}
 
 
 \func{void}{SetColour}{\param{const wxString\& }{colourName}}
 

-\func{void}{SetColour}{\param{int}{ red}, \param{int}{ green}, \param{int}{ blue}}
+\func{void}{SetColour}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}}

 
 The pen's colour is changed to the given colour.
 
 
 The pen's colour is changed to the given colour.
 


@@ -275,7 +286,7 @@ function is called with a NULL array.
 
 \membersection{wxPen::SetJoin}\label{wxpensetjoin}
 
 
 \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}.
 
 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}.


@@ -302,7 +313,7 @@ Set the pen style.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxPen::wxPen}{wxpenconstr}
+\helpref{wxPen::wxPen}{wxpenctor}

 
 \membersection{wxPen::SetWidth}\label{wxpensetwidth}
 
 
 \membersection{wxPen::SetWidth}\label{wxpensetwidth}
 


@@ -348,7 +359,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.
 
 `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
 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


@@ -362,9 +373,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.
 
 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
 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}
 
 
 \wxheading{See also}
 


@@ -372,19 +383,13 @@ backward compatibility with earlier versions of wxWindows.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxPenList::wxPenList}
+\membersection{wxPenList::wxPenList}\label{wxpenlistctor}

 
 \func{void}{wxPenList}{\void}
 
 Constructor. The application should not construct its own pen list:
 use the object pointer {\bf wxThePenList}.
 
 
 \func{void}{wxPenList}{\void}
 
 Constructor. The application should not construct its own pen list:
 use the object pointer {\bf wxThePenList}.
 

-\membersection{wxPenList::AddPen}\label{wxpenlistaddpen}
-
-\func{void}{AddPen}{\param{wxPen*}{ pen}}
-
-Used internally by wxWindows to add a pen to the list.
-

 \membersection{wxPenList::FindOrCreatePen}\label{wxpenlistfindorcreatepen}
 
 \func{wxPen*}{FindOrCreatePen}{\param{const wxColour\& }{colour}, \param{int}{ width}, \param{int}{ style}}
 \membersection{wxPenList::FindOrCreatePen}\label{wxpenlistfindorcreatepen}
 
 \func{wxPen*}{FindOrCreatePen}{\param{const wxColour\& }{colour}, \param{int}{ width}, \param{int}{ style}}


@@ -405,12 +410,4 @@ to the pen list, and returns it.
 
 \docparam{width}{Width of pen.}
 
 
 \docparam{width}{Width of pen.}
 

-\docparam{style}{Pen style. See \helpref{wxPen::wxPen}{wxpenconstr} for a list of styles.}
-
-\membersection{wxPenList::RemovePen}\label{wxpenlistremovepen}
-
-\func{void}{RemovePen}{\param{wxPen*}{ pen}}
-
-Used by wxWindows to remove a pen from the list.
-
-
+\docparam{style}{Pen style. See \helpref{wxPen::wxPen}{wxpenctor} for a list of styles.}