missing closing bracket broke tex2rtf

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

diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex
index 5fea225475357267e4d5cd035df7fa9ca6b23022..645030f2169b6e9103a53ebe4b424e00bd589a9a 100644 (file)
--- a/docs/latex/wx/brush.tex
+++ b/docs/latex/wx/brush.tex
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        brush.tex
+%% Purpose:     wxPen docs
+%% Author:
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+

 \section{\class{wxBrush}}\label{wxbrush}
 
 A brush is a drawing tool for filling in areas. It is used for painting
 \section{\class{wxBrush}}\label{wxbrush}
 
 A brush is a drawing tool for filling in areas. It is used for painting


@@ -34,7 +45,7 @@ wxRED\_BRUSH}
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-On a monochrome display, wxWindows shows
+On a monochrome display, wxWidgets shows

 all brushes as white unless the colour is really black.
 
 Do not initialize objects on the stack before the program commences,
 all brushes as white unless the colour is really black.
 
 Do not initialize objects on the stack before the program commences,


@@ -49,10 +60,11 @@ application may wish to get a pointer to a brush by using the global
 list of brushes {\bf wxTheBrushList}, and calling the member function
 \rtfsp{\bf FindOrCreateBrush}.
 
 list of brushes {\bf wxTheBrushList}, and calling the member function
 \rtfsp{\bf FindOrCreateBrush}.
 

-wxBrush uses a reference counting system, so assignments between brushes are very
-cheap. You can therefore use actual wxBrush objects instead of pointers without
-efficiency problems. Once one wxBrush object changes its data it will create its
-own brush data internally so that other brushes, which previously shared the
+This class uses \helpref{reference counting and copy-on-write}{trefcount}
+internally so that assignments between two instances of this class are very
+cheap. You can therefore use actual objects instead of pointers without
+efficiency problems. If an instance of this class is changed it will create
+its own data internally so that other instances, which previously shared the

 data using the reference counting, are not affected.
 
 %TODO: an overview for wxBrush.
 data using the reference counting, are not affected.
 
 %TODO: an overview for wxBrush.


@@ -62,11 +74,12 @@ data using the reference counting, are not affected.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxBrush::wxBrush}
+
+\membersection{wxBrush::wxBrush}\label{wxbrushctor}

 
 \func{}{wxBrush}{\void}
 
 
 \func{}{wxBrush}{\void}
 

-Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will
+Default constructor. The brush will be uninitialised, and \helpref{wxBrush:IsOk}{wxbrushisok} will

 return false.
 
 \func{}{wxBrush}{\param{const wxColour\&}{ colour}, \param{int}{ style = {\tt wxSOLID}}}
 return false.
 
 \func{}{wxBrush}{\param{const wxColour\&}{ colour}, \param{int}{ style = {\tt wxSOLID}}}


@@ -83,7 +96,7 @@ Constructs a stippled brush using a bitmap.
 
 \func{}{wxBrush}{\param{const wxBrush\&}{ brush}}
 
 
 \func{}{wxBrush}{\param{const wxBrush\&}{ brush}}
 

-Copy constructor. This uses reference counting so is a cheap operation.
+Copy constructor, uses \helpref{reference counting}{trefcount}.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -96,6 +109,7 @@ Copy constructor. This uses reference counting so is a cheap operation.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxTRANSPARENT}}{Transparent (no fill).}
 \twocolitem{{\bf wxSOLID}}{Solid.}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxTRANSPARENT}}{Transparent (no fill).}
 \twocolitem{{\bf wxSOLID}}{Solid.}

+\twocolitem{{\bf wxSTIPPLE}}{Uses a bitmap as a stipple.}

 \twocolitem{{\bf wxBDIAGONAL\_HATCH}}{Backward diagonal hatch.}
 \twocolitem{{\bf wxCROSSDIAG\_HATCH}}{Cross-diagonal hatch.}
 \twocolitem{{\bf wxFDIAGONAL\_HATCH}}{Forward diagonal hatch.}
 \twocolitem{{\bf wxBDIAGONAL\_HATCH}}{Backward diagonal hatch.}
 \twocolitem{{\bf wxCROSSDIAG\_HATCH}}{Cross-diagonal hatch.}
 \twocolitem{{\bf wxFDIAGONAL\_HATCH}}{Forward diagonal hatch.}


@@ -116,22 +130,22 @@ If a stipple brush is created, the brush style will be set to wxSTIPPLE.
 
 \helpref{wxBrushList}{wxbrushlist}, \helpref{wxColour}{wxcolour}, \helpref{wxColourDatabase}{wxcolourdatabase}
 
 
 \helpref{wxBrushList}{wxbrushlist}, \helpref{wxColour}{wxcolour}, \helpref{wxColourDatabase}{wxcolourdatabase}
 

-\membersection{wxBrush::\destruct{wxBrush}}

 
 

-\func{void}{\destruct{wxBrush}}{\void}
+\membersection{wxBrush::\destruct{wxBrush}}\label{wxbrushdtor}
+
+\func{}{\destruct{wxBrush}}{\void}

 
 Destructor.
 
 Destructor.

+See \helpref{reference-counted object destruction}{refcountdestruct} for more info.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-The destructor may not delete the underlying brush object of the native windowing
-system, since wxBrush uses a reference counting system for efficiency.
-

 Although all remaining brushes are deleted when the application exits,
 the application should try to clean up all brushes itself. This is because
 Although all remaining brushes are deleted when the application exits,
 the application should try to clean up all brushes itself. This is because

-wxWindows cannot know if a pointer to the brush object is stored in an
+wxWidgets cannot know if a pointer to the brush object is stored in an

 application data structure, and there is a risk of double deletion.
 
 application data structure, and there is a risk of double deletion.
 

+

 \membersection{wxBrush::GetColour}\label{wxbrushgetcolour}
 
 \constfunc{wxColour\&}{GetColour}{\void}
 \membersection{wxBrush::GetColour}\label{wxbrushgetcolour}
 
 \constfunc{wxColour\&}{GetColour}{\void}


@@ -142,17 +156,19 @@ Returns a reference to the brush colour.
 
 \helpref{wxBrush::SetColour}{wxbrushsetcolour}
 
 
 \helpref{wxBrush::SetColour}{wxbrushsetcolour}
 

+

 \membersection{wxBrush::GetStipple}\label{wxbrushgetstipple}
 
 \constfunc{wxBitmap *}{GetStipple}{\void}
 
 Gets a pointer to the stipple bitmap. If the brush does not have a wxSTIPPLE style,
 \membersection{wxBrush::GetStipple}\label{wxbrushgetstipple}
 
 \constfunc{wxBitmap *}{GetStipple}{\void}
 
 Gets a pointer to the stipple bitmap. If the brush does not have a wxSTIPPLE style,

-this bitmap may be non-NULL but uninitialised (\helpref{wxBitmap::Ok}{wxbitmapok} returns false).
+this bitmap may be non-NULL but uninitialised (\helpref{wxBitmap:IsOk}{wxbitmapisok} returns false).

 
 \wxheading{See also}
 
 \helpref{wxBrush::SetStipple}{wxbrushsetstipple}
 
 
 \wxheading{See also}
 
 \helpref{wxBrush::SetStipple}{wxbrushsetstipple}
 

+

 \membersection{wxBrush::GetStyle}\label{wxbrushgetstyle}
 
 \constfunc{int}{GetStyle}{\void}
 \membersection{wxBrush::GetStyle}\label{wxbrushgetstyle}
 
 \constfunc{int}{GetStyle}{\void}


@@ -177,14 +193,27 @@ Returns the brush style, one of:
 \helpref{wxBrush::SetStyle}{wxbrushsetstyle}, \helpref{wxBrush::SetColour}{wxbrushsetcolour},\rtfsp
 \helpref{wxBrush::SetStipple}{wxbrushsetstipple}
 
 \helpref{wxBrush::SetStyle}{wxbrushsetstyle}, \helpref{wxBrush::SetColour}{wxbrushsetcolour},\rtfsp
 \helpref{wxBrush::SetStipple}{wxbrushsetstipple}
 

-\membersection{wxBrush::Ok}\label{wxbrushok}

 
 

-\constfunc{bool}{Ok}{\void}
+\membersection{wxBrush::IsHatch}\label{wxbrushishatch}
+
+\constfunc{bool}{IsHatch}{\void}
+
+Returns true if the style of the brush is any of hatched fills.
+
+\wxheading{See also}
+
+\helpref{wxBrush::GetStyle}{wxbrushgetstyle}
+
+
+\membersection{wxBrush::IsOk}\label{wxbrushisok}
+
+\constfunc{bool}{IsOk}{\void}

 
 Returns true if the brush is initialised. It will return false if the default
 constructor has been used (for example, the brush is a member of a class, or
 NULL has been assigned to it).
 
 
 Returns true if the brush is initialised. It will return false if the default
 constructor has been used (for example, the brush is a member of a class, or
 NULL has been assigned to it).
 

+

 \membersection{wxBrush::SetColour}\label{wxbrushsetcolour}
 
 \func{void}{SetColour}{\param{wxColour\& }{colour}}
 \membersection{wxBrush::SetColour}\label{wxbrushsetcolour}
 
 \func{void}{SetColour}{\param{wxColour\& }{colour}}


@@ -195,7 +224,7 @@ Sets the brush colour using a reference to a colour object.
 
 Sets the brush colour using a colour name from the colour database.
 
 
 Sets the brush colour using a colour name from the colour database.
 

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

 
 Sets the brush colour using red, green and blue values.
 
 
 Sets the brush colour using red, green and blue values.
 


@@ -203,6 +232,7 @@ Sets the brush colour using red, green and blue values.
 
 \helpref{wxBrush::GetColour}{wxbrushgetcolour}
 
 
 \helpref{wxBrush::GetColour}{wxbrushgetcolour}
 

+

 \membersection{wxBrush::SetStipple}\label{wxbrushsetstipple}
 
 \func{void}{SetStipple}{\param{const wxBitmap\&}{ bitmap}}
 \membersection{wxBrush::SetStipple}\label{wxbrushsetstipple}
 
 \func{void}{SetStipple}{\param{const wxBitmap\&}{ bitmap}}


@@ -231,6 +261,7 @@ supported, Windows 98 and NT as well as GTK support arbitrary bitmaps.
 
 \helpref{wxBitmap}{wxbitmap}
 
 
 \helpref{wxBitmap}{wxbitmap}
 

+

 \membersection{wxBrush::SetStyle}\label{wxbrushsetstyle}
 
 \func{void}{SetStyle}{\param{int}{ style}}
 \membersection{wxBrush::SetStyle}\label{wxbrushsetstyle}
 
 \func{void}{SetStyle}{\param{int}{ style}}


@@ -256,28 +287,29 @@ Sets the brush style.
 
 \helpref{wxBrush::GetStyle}{wxbrushgetstyle}
 
 
 \helpref{wxBrush::GetStyle}{wxbrushgetstyle}
 

+

 \membersection{wxBrush::operator $=$}\label{wxbrushassignment}
 
 \func{wxBrush\&}{operator $=$}{\param{const wxBrush\& }{brush}}
 
 \membersection{wxBrush::operator $=$}\label{wxbrushassignment}
 
 \func{wxBrush\&}{operator $=$}{\param{const wxBrush\& }{brush}}
 

-Assignment operator, using reference counting. Returns a reference
-to `this'.
+Assignment operator, using \helpref{reference counting}{trefcount}.
+

 
 \membersection{wxBrush::operator $==$}\label{wxbrushequals}
 
 \func{bool}{operator $==$}{\param{const wxBrush\& }{brush}}
 
 
 \membersection{wxBrush::operator $==$}\label{wxbrushequals}
 
 \func{bool}{operator $==$}{\param{const wxBrush\& }{brush}}
 

-Equality operator. Two brushes are equal if they contain pointers
-to the same underlying brush data. It does not compare each attribute,
-so two independently-created brushes using the same parameters will
-fail the test.
+Equality operator.
+See \helpref{reference-counted object comparison}{refcountequality} for more info.
+

 
 \membersection{wxBrush::operator $!=$}\label{wxbrushnotequals}
 
 \func{bool}{operator $!=$}{\param{const wxBrush\& }{brush}}
 
 
 \membersection{wxBrush::operator $!=$}\label{wxbrushnotequals}
 
 \func{bool}{operator $!=$}{\param{const wxBrush\& }{brush}}
 

-Inequality operator. Two brushes are not equal if they contain pointers
-to different underlying brush data. It does not compare each attribute.
+Inequality operator.
+See \helpref{reference-counted object comparison}{refcountequality} for more info.
+

 
 \section{\class{wxBrushList}}\label{wxbrushlist}
 
 
 \section{\class{wxBrushList}}\label{wxbrushlist}
 


@@ -303,12 +335,12 @@ 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

 brush list less useful than it once was. Under Windows, scarce resources
 brush list less useful than it once was. Under Windows, scarce resources

-are cleaned up internally if they are not being used. Also, a referencing
+are cleaned up internally if they are not being used. Also, a reference

 counting mechanism applied to all GDI objects means that some sharing
 of underlying resources is possible. You don't have to keep track of pointers,
 counting mechanism applied to all GDI objects means that some sharing
 of underlying resources is possible. You don't have to keep track of pointers,

-working out when it is safe delete a brush, because the referencing counting does
+working out when it is safe delete a brush, because the reference counting does

 it for you. For example, you can set a brush in a device context, and then
 immediately delete the brush you passed, because the brush is `copied'.
 
 it for you. For example, you can set a brush in a device context, and then
 immediately delete the brush you passed, because the brush is `copied'.
 


@@ -317,9 +349,9 @@ and copy brushes 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 brush list is for wxWindows to keep
+The only compelling use for the brush list is for wxWidgets to keep

 track of brushes in order to clean them up on exit. It is also kept for
 track of brushes 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}
 


@@ -327,6 +359,7 @@ backward compatibility with earlier versions of wxWindows.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxBrushList::wxBrushList}\label{wxbrushlistconstr}
 
 \func{void}{wxBrushList}{\void}
 \membersection{wxBrushList::wxBrushList}\label{wxbrushlistconstr}
 
 \func{void}{wxBrushList}{\void}


@@ -334,38 +367,18 @@ backward compatibility with earlier versions of wxWindows.
 Constructor. The application should not construct its own brush list:
 use the object pointer {\bf wxTheBrushList}.
 
 Constructor. The application should not construct its own brush list:
 use the object pointer {\bf wxTheBrushList}.
 

-\membersection{wxBrushList::AddBrush}\label{wxbrushlistaddbrush}
-
-\func{void}{AddBrush}{\param{wxBrush *}{brush}}
-
-Used internally by wxWindows to add a brush to the list.

 
 \membersection{wxBrushList::FindOrCreateBrush}\label{wxbrushlistfindorcreatebrush}
 
 
 \membersection{wxBrushList::FindOrCreateBrush}\label{wxbrushlistfindorcreatebrush}
 

-\func{wxBrush *}{FindOrCreateBrush}{\param{const wxColour\& }{colour}, \param{int}{ style}}
+\func{wxBrush *}{FindOrCreateBrush}{\param{const wxColour\& }{colour}, \param{int}{ style = wxSOLID}}

 
 Finds a brush with the specified attributes and returns it, else creates a new brush, adds it
 to the brush list, and returns it.
 
 
 Finds a brush with the specified attributes and returns it, else creates a new brush, adds it
 to the brush list, and returns it.
 

-\func{wxBrush *}{FindOrCreateBrush}{\param{const wxString\& }{colourName}, \param{int}{ style}}
-
-Finds a brush with the specified attributes and returns it, else creates a new brush, adds it
-to the brush list, and returns it.
-
-Finds a brush of the given specification, or creates one and adds it to the list.
-

 \wxheading{Parameters}
 
 \docparam{colour}{Colour object.}
 
 \wxheading{Parameters}
 
 \docparam{colour}{Colour object.}
 

-\docparam{colourName}{Colour name, which should be in the colour database.}
-

 \docparam{style}{Brush style. See \helpref{wxBrush::SetStyle}{wxbrushsetstyle} for a list of styles.}
 
 \docparam{style}{Brush style. See \helpref{wxBrush::SetStyle}{wxbrushsetstyle} for a list of styles.}
 

-\membersection{wxBrushList::RemoveBrush}\label{wxbrushlistremovebrush}
-
-\func{void}{RemoveBrush}{\param{wxBrush *}{brush}}
-
-Used by wxWindows to remove a brush from the list.
-