X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eaaa6a06a25774c18d10bb8182cc1934ed0ed9aa..69b5cec2b0993ce4cd56f2e50ab94e5ebd20069c:/docs/latex/wx/brush.tex?ds=inline

diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex
index d707dcf875..5fea225475 100644
--- a/docs/latex/wx/brush.tex
+++ b/docs/latex/wx/brush.tex
@@ -9,6 +9,29 @@ style.
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/brush.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullBrush}
+
+Pointers:
+
+{\bf wxBLUE\_BRUSH\\
+wxGREEN\_BRUSH\\
+wxWHITE\_BRUSH\\
+wxBLACK\_BRUSH\\
+wxGREY\_BRUSH\\
+wxMEDIUM\_GREY\_BRUSH\\
+wxLIGHT\_GREY\_BRUSH\\
+wxTRANSPARENT\_BRUSH\\
+wxCYAN\_BRUSH\\
+wxRED\_BRUSH}
+
 \wxheading{Remarks}
 
 On a monochrome display, wxWindows shows
@@ -28,12 +51,11 @@ list of brushes {\bf wxTheBrushList}, and calling the member function
 
 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. Bear in mind, though, that changing a brush's properties may
-affect another brush which has been involved in an assignment with the first brush,
-because of the way internal brush data is shared.
-
-TODO: an overview for wxBrush.
+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
+data using the reference counting, are not affected.
 
+%TODO: an overview for wxBrush.
 \wxheading{See also}
 
 \helpref{wxBrushList}{wxbrushlist}, \helpref{wxDC}{wxdc}, \helpref{wxDC::SetBrush}{wxdcsetbrush}
@@ -45,9 +67,9 @@ TODO: an overview for wxBrush.
 \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.
 
@@ -63,10 +85,6 @@ Constructs a stippled brush using a bitmap.
 
 Copy constructor. This uses reference counting so is a cheap operation.
 
-\func{}{wxBrush}{\param{const wxBrush*}{ brush}}
-
-Copy constructor. This uses reference counting so is a cheap operation.
-
 \wxheading{Parameters}
 
 \docparam{colour}{Colour object.}
@@ -129,7 +147,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,
-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}
 
@@ -151,6 +169,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 wxSTIPPLE\_MASK\_OPAQUE}}{Stippled using a bitmap's mask.}
 \end{twocollist}
 
 \wxheading{See also}
@@ -162,7 +181,7 @@ Returns the brush style, one of:
 
 \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).
 
@@ -196,13 +215,17 @@ Sets the stipple bitmap.
 
 \wxheading{Remarks}
 
-The style will be set to wxSTIPPLE.
+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.
 
-Note that there is a big difference between stippling in X and Windows.
-On X, the stipple is a mask between the wxBitmap and current colour.
-On Windows, the current colour is ignored, and the bitmap colour is used.
-However, for pre-defined modes like wxCROSS\_HATCH, the behaviour is the
-same for both platforms.
+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
+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.
+
+Note that under Windows 95, only 8x8 pixel large stipple bitmaps are
+supported, Windows 98 and NT as well as GTK support arbitrary bitmaps.
 
 \wxheading{See also}
 
@@ -226,6 +249,7 @@ 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 wxSTIPPLE\_MASK\_OPAQUE}}{Stippled using a bitmap's mask.}
 \end{twocollist}}
 
 \wxheading{See also}
@@ -264,6 +288,10 @@ A brush list is a list containing all brushes which have been created.
 \helpref{wxList}{wxlist}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
 \wxheading{Remarks}
 
 There is only one instance of this class: {\bf wxTheBrushList}.  Use
