Add *wxTopLevelWindowGTK*RequestUserAttention*int*;

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

diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex
index fd1c0a756c239c7fdf86b268a82f1fadee2b5bc3..dfc9a09aea2ddb0b9e33d453a0aee50a868cc6b0 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,15 @@ 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 +97,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,9 +118,10 @@ 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.
 


@@ -129,9 +132,10 @@ 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 +146,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::Ok}{wxbitmapok} 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}


@@ -169,7 +175,7 @@ Returns the brush style, one of:
 \twocolitem{{\bf wxHORIZONTAL\_HATCH}}{Horizontal hatch.}
 \twocolitem{{\bf wxVERTICAL\_HATCH}}{Vertical hatch.}
 \twocolitem{{\bf wxSTIPPLE}}{Stippled using a bitmap.}
 \twocolitem{{\bf wxHORIZONTAL\_HATCH}}{Horizontal hatch.}
 \twocolitem{{\bf wxVERTICAL\_HATCH}}{Vertical hatch.}
 \twocolitem{{\bf wxSTIPPLE}}{Stippled using a bitmap.}

-\twocolitem{{\bf wxSTIPPLE_MASK_OPAQUE}}{Stippled using a bitmap's mask.}
+\twocolitem{{\bf wxSTIPPLE\_MASK\_OPAQUE}}{Stippled using a bitmap's mask.}

 \end{twocollist}
 
 \wxheading{See also}
 \end{twocollist}
 
 \wxheading{See also}


@@ -177,14 +183,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::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).
 

+

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


@@ -203,6 +222,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}}


@@ -216,10 +236,10 @@ Sets the stipple bitmap.
 \wxheading{Remarks}
 
 The style will be set to wxSTIPPLE, unless the bitmap has a mask associated
 \wxheading{Remarks}
 
 The style will be set to wxSTIPPLE, unless the bitmap has a mask associated

-to it, in which case the style will be set to wxSTIPPLE_MASK_OPAQUE.
+to it, in which case the style will be set to wxSTIPPLE\_MASK\_OPAQUE.

 
 If the wxSTIPPLE variant is used, the bitmap will be used to fill out the
 
 If the wxSTIPPLE variant is used, the bitmap will be used to fill out the

-area to be drawn. If the wxSTIPPLE_MASK_OPAQUE is used, the current
+area to be drawn. If the wxSTIPPLE\_MASK\_OPAQUE is used, the current

 text foreground and text background determine what colours are used for
 displaying and the bits in the mask (which is a mono-bitmap actually)
 determine where to draw what.
 text foreground and text background determine what colours are used for
 displaying and the bits in the mask (which is a mono-bitmap actually)
 determine where to draw what.


@@ -231,6 +251,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}}


@@ -249,13 +270,14 @@ Sets the brush style.
 \twocolitem{{\bf wxHORIZONTAL\_HATCH}}{Horizontal hatch.}
 \twocolitem{{\bf wxVERTICAL\_HATCH}}{Vertical hatch.}
 \twocolitem{{\bf wxSTIPPLE}}{Stippled using a bitmap.}
 \twocolitem{{\bf wxHORIZONTAL\_HATCH}}{Horizontal hatch.}
 \twocolitem{{\bf wxVERTICAL\_HATCH}}{Vertical hatch.}
 \twocolitem{{\bf wxSTIPPLE}}{Stippled using a bitmap.}

-\twocolitem{{\bf wxSTIPPLE_MASK_OPAQUE}}{Stippled using a bitmap's mask.}
+\twocolitem{{\bf wxSTIPPLE\_MASK\_OPAQUE}}{Stippled using a bitmap's mask.}

 \end{twocollist}}
 
 \wxheading{See also}
 
 \helpref{wxBrush::GetStyle}{wxbrushgetstyle}
 
 \end{twocollist}}
 
 \wxheading{See also}
 
 \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}}


@@ -263,6 +285,7 @@ Sets the brush style.
 Assignment operator, using reference counting. Returns a reference
 to `this'.
 
 Assignment operator, using reference counting. Returns a reference
 to `this'.
 

+

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


@@ -272,6 +295,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.
 
 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}}
 \membersection{wxBrush::operator $!=$}\label{wxbrushnotequals}
 
 \func{bool}{operator $!=$}{\param{const wxBrush\& }{brush}}


@@ -303,12 +327,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 +341,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 +351,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 +359,32 @@ 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}}
 
 \membersection{wxBrushList::AddBrush}\label{wxbrushlistaddbrush}
 
 \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}

 
 

-\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 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}}
 
 \membersection{wxBrushList::RemoveBrush}\label{wxbrushlistremovebrush}
 
 \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.