Added ForceRefresh() to request immediate repainting of a grid.

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

diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex
index 8fa085f78eb5a86c552a918d827e5c5a3c0d717e..fd1c0a756c239c7fdf86b268a82f1fadee2b5bc3 100644 (file)
--- a/docs/latex/wx/brush.tex
+++ b/docs/latex/wx/brush.tex
@@ -9,6 +9,29 @@ style.
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
 \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
 \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
 
 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}
 \wxheading{See also}
 
 \helpref{wxBrushList}{wxbrushlist}, \helpref{wxDC}{wxdc}, \helpref{wxDC::SetBrush}{wxdcsetbrush}


@@ -47,11 +69,11 @@ TODO: an overview for wxBrush.
 Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will
 return FALSE.
 
 Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will
 return FALSE.
 

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

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

-\func{}{wxBrush}{\param{const wxString\& }{colourName}, \param{const int}{ style}}
+\func{}{wxBrush}{\param{const wxString\& }{colourName}, \param{int}{ style}}

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


@@ -63,10 +85,6 @@ Constructs a stippled brush using a bitmap.
 
 Copy constructor. This uses reference counting so is a cheap operation.
 
 
 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.}
 \wxheading{Parameters}
 
 \docparam{colour}{Colour object.}


@@ -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 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}
 \end{twocollist}
 
 \wxheading{See also}


@@ -196,13 +215,17 @@ Sets the stipple bitmap.
 
 \wxheading{Remarks}
 
 
 \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}
 
 
 \wxheading{See also}
 


@@ -210,7 +233,7 @@ same for both platforms.
 
 \membersection{wxBrush::SetStyle}\label{wxbrushsetstyle}
 
 
 \membersection{wxBrush::SetStyle}\label{wxbrushsetstyle}
 

-\func{void}{SetStyle}{\param{const int}{ style}}
+\func{void}{SetStyle}{\param{int}{ style}}

 
 Sets the brush style.
 
 
 Sets the brush style.
 


@@ -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 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}
 \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}
 
 \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
 \wxheading{Remarks}
 
 There is only one instance of this class: {\bf wxTheBrushList}.  Use


@@ -314,12 +342,12 @@ 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{const int}{ style}}
+\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.
 
 
 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{const int}{ style}}
+\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 with the specified attributes and returns it, else creates a new brush, adds it
 to the brush list, and returns it.