X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc2171bd4c660b8554dae2a1cbf34ff09f3032a6..93bfe54527a7a64ea87cdc03be3015f7963fd227:/docs/latex/wx/brush.tex?ds=sidebyside

diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex
index 3d0da40f3b..08b3f0cfbf 100644
--- 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
@@ -62,7 +73,8 @@ data using the reference counting, are not affected.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxBrush::wxBrush}
+
+\membersection{wxBrush::wxBrush}\label{wxbrushctor}
 
 \func{}{wxBrush}{\void}
 
@@ -117,9 +129,10 @@ If a stipple brush is created, the brush style will be set to wxSTIPPLE.
 
 \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.
 
@@ -133,6 +146,7 @@ the application should try to clean up all brushes itself. This is because
 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.
 
+
 \membersection{wxBrush::GetColour}\label{wxbrushgetcolour}
 
 \constfunc{wxColour\&}{GetColour}{\void}
@@ -143,6 +157,7 @@ Returns a reference to the brush colour.
 
 \helpref{wxBrush::SetColour}{wxbrushsetcolour}
 
+
 \membersection{wxBrush::GetStipple}\label{wxbrushgetstipple}
 
 \constfunc{wxBitmap *}{GetStipple}{\void}
@@ -154,6 +169,7 @@ this bitmap may be non-NULL but uninitialised (\helpref{wxBitmap::Ok}{wxbitmapok
 
 \helpref{wxBrush::SetStipple}{wxbrushsetstipple}
 
+
 \membersection{wxBrush::GetStyle}\label{wxbrushgetstyle}
 
 \constfunc{int}{GetStyle}{\void}
@@ -178,6 +194,18 @@ Returns the brush style, one of:
 \helpref{wxBrush::SetStyle}{wxbrushsetstyle}, \helpref{wxBrush::SetColour}{wxbrushsetcolour},\rtfsp
 \helpref{wxBrush::SetStipple}{wxbrushsetstipple}
 
+
+\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::Ok}\label{wxbrushok}
 
 \constfunc{bool}{Ok}{\void}
@@ -186,6 +214,7 @@ 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}}
@@ -196,7 +225,7 @@ Sets the brush colour using a reference to a colour object.
 
 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.
 
@@ -204,6 +233,7 @@ Sets the brush colour using red, green and blue values.
 
 \helpref{wxBrush::GetColour}{wxbrushgetcolour}
 
+
 \membersection{wxBrush::SetStipple}\label{wxbrushsetstipple}
 
 \func{void}{SetStipple}{\param{const wxBitmap\&}{ bitmap}}
@@ -232,6 +262,7 @@ supported, Windows 98 and NT as well as GTK support arbitrary bitmaps.
 
 \helpref{wxBitmap}{wxbitmap}
 
+
 \membersection{wxBrush::SetStyle}\label{wxbrushsetstyle}
 
 \func{void}{SetStyle}{\param{int}{ style}}
@@ -257,6 +288,7 @@ Sets the brush style.
 
 \helpref{wxBrush::GetStyle}{wxbrushgetstyle}
 
+
 \membersection{wxBrush::operator $=$}\label{wxbrushassignment}
 
 \func{wxBrush\&}{operator $=$}{\param{const wxBrush\& }{brush}}
@@ -264,6 +296,7 @@ Sets the brush style.
 Assignment operator, using reference counting. Returns a reference
 to `this'.
 
+
 \membersection{wxBrush::operator $==$}\label{wxbrushequals}
 
 \func{bool}{operator $==$}{\param{const wxBrush\& }{brush}}
@@ -273,6 +306,7 @@ 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.
 
+
 \membersection{wxBrush::operator $!=$}\label{wxbrushnotequals}
 
 \func{bool}{operator $!=$}{\param{const wxBrush\& }{brush}}
@@ -306,10 +340,10 @@ cleanup because it can lead to double deletion in some circumstances.
 
 There are two mechanisms in recent versions of wxWidgets which make the
 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,
-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'.
 
@@ -328,6 +362,7 @@ backward compatibility with earlier versions of wxWidgets.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxBrushList::wxBrushList}\label{wxbrushlistconstr}
 
 \func{void}{wxBrushList}{\void}
@@ -335,34 +370,28 @@ backward compatibility with earlier versions of wxWidgets.
 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 wxWidgets to add a brush to the list.
 
-\membersection{wxBrushList::FindOrCreateBrush}\label{wxbrushlistfindorcreatebrush}
 
-\func{wxBrush *}{FindOrCreateBrush}{\param{const wxColour\& }{colour}, \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.
+\membersection{wxBrushList::FindOrCreateBrush}\label{wxbrushlistfindorcreatebrush}
 
-\func{wxBrush *}{FindOrCreateBrush}{\param{const wxString\& }{colourName}, \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 of the given specification, or creates one and adds it to the list.
-
 \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.}
 
+
 \membersection{wxBrushList::RemoveBrush}\label{wxbrushlistremovebrush}
 
 \func{void}{RemoveBrush}{\param{wxBrush *}{brush}}