On wxMac don't call Refresh from FullPaint as that is the biggest

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

diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex
index f11d4f97da8b172fe50d34c794d994b3e67227fa..2c1c31d47ca1e19ca2e99e628161a6ce39309f72 100644 (file)
--- a/docs/latex/wx/brush.tex
+++ b/docs/latex/wx/brush.tex
@@ -34,7 +34,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,


@@ -62,14 +62,14 @@ 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}
 
 Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will
 
 \func{}{wxBrush}{\void}
 
 Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will

-return FALSE.
+return false.

 
 

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

 
 Constructs a brush from a colour object and style.
 
 
 Constructs a brush from a colour object and style.
 


@@ -96,6 +96,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,7 +117,7 @@ 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}}
+\membersection{wxBrush::\destruct{wxBrush}}\label{wxbrushdtor}

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


@@ -129,7 +130,7 @@ 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.
 
 \membersection{wxBrush::GetColour}\label{wxbrushgetcolour}
 application data structure, and there is a risk of double deletion.
 
 \membersection{wxBrush::GetColour}\label{wxbrushgetcolour}


@@ -147,7 +148,7 @@ Returns a reference to the brush colour.
 \constfunc{wxBitmap *}{GetStipple}{\void}
 
 Gets a pointer to the stipple bitmap. If the brush does not have a wxSTIPPLE style,
 \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::Ok}{wxbitmapok} returns false).

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -177,11 +178,21 @@ 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::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}
 
 \membersection{wxBrush::Ok}\label{wxbrushok}
 
 \constfunc{bool}{Ok}{\void}
 

-Returns TRUE if the brush is initialised. It will return FALSE if the default
+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).
 
 constructor has been used (for example, the brush is a member of a class, or
 NULL has been assigned to it).
 


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

 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
 counting mechanism applied to all GDI objects means that some sharing
 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
 counting mechanism applied to all GDI objects means that some sharing


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


@@ -338,7 +349,7 @@ use the object pointer {\bf wxTheBrushList}.
 
 \func{void}{AddBrush}{\param{wxBrush *}{brush}}
 
 
 \func{void}{AddBrush}{\param{wxBrush *}{brush}}
 

-Used internally by wxWindows to add a brush to the list.
+Used internally by wxWidgets to add a brush to the list.

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


@@ -366,6 +377,6 @@ Finds a brush of the given specification, or creates one and adds it to the list
 
 \func{void}{RemoveBrush}{\param{wxBrush *}{brush}}
 
 
 \func{void}{RemoveBrush}{\param{wxBrush *}{brush}}
 

-Used by wxWindows to remove a brush from the list.
+Used by wxWidgets to remove a brush from the list.