Daniel Gehriger <dgehrige@dmtsun.epfl.ch> patch for default extension filter

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

diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex
index 53ab713835c4dfd019ea509572d683c3dc2129e0..5a369a34245e3463bec4e4056241d174451d1a19 100644 (file)
--- a/docs/latex/wx/pen.tex
+++ b/docs/latex/wx/pen.tex
@@ -20,6 +20,12 @@ get a pointer to a pen by using the global list of pens {\bf
 wxThePenList}, and calling the member function {\bf FindOrCreatePen}.
 See the entry for \helpref{wxPenList}{wxpenlist}.
 
+wxPen uses a reference counting system, so assignments between brushes are very
+cheap. You can therefore use actual wxPen objects instead of pointers without
+efficiency problems. Once one wxPen object changes its data it will create its
+own pen data internally so that other pens, which previously shared the
+data using the reference counting, are not affected.
+
 TODO: an overview for wxPen.
 
 \wxheading{See also}
@@ -35,15 +41,15 @@ TODO: an overview for wxPen.
 Default constructor. The pen will be uninitialised, and \helpref{wxPen::Ok}{wxpenok} will
 return FALSE.
 
-\func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{const int}{ width}, \param{const int}{ style}}
+\func{}{wxPen}{\param{const wxColour\&}{ colour}, \param{int}{ width}, \param{int}{ style}}
 
 Constructs a pen from a colour object, pen width and style.
 
-\func{}{wxPen}{\param{const wxString\& }{colourName}, \param{const int}{ width}, \param{const int}{ style}}
+\func{}{wxPen}{\param{const wxString\& }{colourName}, \param{int}{ width}, \param{int}{ style}}
 
 Constructs a pen from a colour name, pen width and style.
 
-\func{}{wxPen}{\param{const wxBitmap\&}{ stipple}, \param{const int}{ width}}
+\func{}{wxPen}{\param{const wxBitmap\&}{ stipple}, \param{int}{ width}}
 
 Constructs a stippled pen from a stipple bitmap and a width.
 
@@ -51,10 +57,6 @@ Constructs a stippled pen from a stipple bitmap and a width.
 
 Copy constructor. This uses reference counting so is a cheap operation.
 
-\func{}{wxPen}{\param{const wxPen*}{ pen}}
-
-Copy constructor. This uses reference counting so is a cheap operation.
-
 \wxheading{Parameters}
 
 \docparam{colour}{A colour object.}
@@ -216,7 +218,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 int}{ red}, \param{const int}{ green}, \param{const int}{ blue}}
+\func{void}{SetColour}{\param{int}{ red}, \param{int}{ green}, \param{int}{ blue}}
 
 The pen's colour is changed to the given colour.
 
@@ -272,7 +274,7 @@ Set the pen style.
 
 \membersection{wxPen::SetWidth}\label{wxpensetwidth}
 
-\func{void}{SetWidth}{\param{const int}{ width}}
+\func{void}{SetWidth}{\param{int}{ width}}
 
 Sets the pen width.
 
@@ -353,12 +355,12 @@ Used internally by wxWindows to add a pen to the list.
 
 \membersection{wxPenList::FindOrCreatePen}\label{wxpenlistfindorcreatepen}
 
-\func{wxPen*}{FindOrCreatePen}{\param{const wxColour\& }{colour}, \param{const int}{ width}, \param{const int}{ style}}
+\func{wxPen*}{FindOrCreatePen}{\param{const wxColour\& }{colour}, \param{int}{ width}, \param{int}{ style}}
 
 Finds a pen with the specified attributes and returns it, else creates a new pen, adds it
 to the pen list, and returns it.
 
-\func{wxPen*}{FindOrCreatePen}{\param{const wxString\& }{colourName}, \param{const int}{ width}, \param{const int}{ style}}
+\func{wxPen*}{FindOrCreatePen}{\param{const wxString\& }{colourName}, \param{int}{ width}, \param{int}{ style}}
 
 Finds a pen with the specified attributes and returns it, else creates a new pen, adds it
 to the pen list, and returns it.