finished implementation for stencil and colored patterns

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

diff --git a/docs/latex/wx/pen.tex b/docs/latex/wx/pen.tex
index 53ab713835c4dfd019ea509572d683c3dc2129e0..c92c4834be4774f8e42c786a7ec1351aef29fa04 100644 (file)
--- a/docs/latex/wx/pen.tex
+++ b/docs/latex/wx/pen.tex
@@ -1,12 +1,51 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% 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}
+
+\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}
 
 
 \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,


@@ -20,30 +59,35 @@ 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}.
 
 wxThePenList}, and calling the member function {\bf FindOrCreatePen}.
 See the entry for \helpref{wxPenList}{wxpenlist}.
 

-TODO: an overview for wxPen.
+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}
 
 \helpref{wxPenList}{wxpenlist}, \helpref{wxDC}{wxdc}, \helpref{wxDC::SetPen}{wxdcsetpen}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{See also}
 
 \helpref{wxPenList}{wxpenlist}, \helpref{wxDC}{wxdc}, \helpref{wxDC::SetPen}{wxdcsetpen}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

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

 
 \func{}{wxPen}{\void}
 
 Default constructor. The pen will be uninitialised, and \helpref{wxPen::Ok}{wxpenok} will
 
 \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{const int}{ width}, \param{const 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.
 
 
 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.
 
 
 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.
 
 
 Constructs a stippled pen from a stipple bitmap and a width.
 


@@ -51,10 +95,6 @@ Constructs a stippled pen from a stipple bitmap and a width.
 
 Copy constructor. This uses reference counting so is a cheap operation.
 
 
 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.}
 \wxheading{Parameters}
 
 \docparam{colour}{A colour object.}


@@ -68,9 +108,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{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
 \docparam{style}{The style may be one of the following:
 
 \begin{twocollist}\itemsep=0pt


@@ -92,18 +129,27 @@ the style is wxDOT, wxLONG\_DASH, wxSHORT\_DASH, wxDOT\_DASH, or wxUSER\_DASH.}
 
 \wxheading{Remarks}
 
 
 \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.
 
 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}
 
 \wxheading{See also}
 
 \helpref{wxPen::SetStyle}{wxpensetstyle}, \helpref{wxPen::SetColour}{wxpensetcolour},\rtfsp
 \helpref{wxPen::SetWidth}{wxpensetwidth}, \helpref{wxPen::SetStipple}{wxpensetstipple}
 

-\membersection{wxPen::\destruct{wxPen}}
+\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}}\label{wxpendtor}

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


@@ -116,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}


@@ -181,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}
 


@@ -197,7 +243,7 @@ Returns the pen width.
 
 \constfunc{bool}{Ok}{\void}
 
 
 \constfunc{bool}{Ok}{\void}
 

-Returns TRUE if the pen is initialised.
+Returns true if the pen is initialised.

 
 \membersection{wxPen::SetCap}\label{wxpensetcap}
 
 
 \membersection{wxPen::SetCap}\label{wxpensetcap}
 


@@ -216,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{const int}{ red}, \param{const int}{ green}, \param{const 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.
 


@@ -233,15 +279,14 @@ with the pen. The array is not deallocated by wxPen, but neither must it be
 deallocated by the calling application until the pen is deleted or this
 function is called with a NULL array.
 
 deallocated by the calling application until the pen is deleted or this
 function is called with a NULL array.
 

-TODO: describe in detail.
-
+%TODO: describe in detail.

 \wxheading{See also}
 
 \helpref{wxPen::GetDashes}{wxpengetdashes}
 
 \membersection{wxPen::SetJoin}\label{wxpensetjoin}
 
 \wxheading{See also}
 
 \helpref{wxPen::GetDashes}{wxpengetdashes}
 
 \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}.


@@ -268,11 +313,11 @@ 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}
 

-\func{void}{SetWidth}{\param{const int}{ width}}
+\func{void}{SetWidth}{\param{int}{ width}}

 
 Sets the pen width.
 
 
 Sets the pen width.
 


@@ -314,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


@@ -328,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}
 


@@ -338,7 +383,7 @@ 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}
 
 
 \func{void}{wxPenList}{\void}
 


@@ -349,16 +394,16 @@ use the object pointer {\bf wxThePenList}.
 
 \func{void}{AddPen}{\param{wxPen*}{ pen}}
 
 
 \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}
 
 
 \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.
 
 
 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.
 
 Finds a pen with the specified attributes and returns it, else creates a new pen, adds it
 to the pen list, and returns it.


@@ -367,14 +412,14 @@ to the pen list, and returns it.
 
 \docparam{colour}{Colour object.}
 
 
 \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.}
+\docparam{style}{Pen style. See \helpref{wxPen::wxPen}{wxpenctor} for a list of styles.}

 
 \membersection{wxPenList::RemovePen}\label{wxpenlistremovepen}
 
 \func{void}{RemovePen}{\param{wxPen*}{ pen}}
 
 
 \membersection{wxPenList::RemovePen}\label{wxpenlistremovepen}
 
 \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.