X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..3f8e5072f7391db2158f44c6b9209bbb3db6eb06:/docs/latex/wx/brush.tex diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex index 8fa085f78e..a12f90b4dd 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} + + + +\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} @@ -47,11 +69,11 @@ TODO: an overview for wxBrush. 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. -\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. @@ -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.} @@ -210,7 +228,7 @@ same for both platforms. \membersection{wxBrush::SetStyle}\label{wxbrushsetstyle} -\func{void}{SetStyle}{\param{const int}{ style}} +\func{void}{SetStyle}{\param{int}{ style}} Sets the brush style. @@ -264,6 +282,10 @@ A brush list is a list containing all brushes which have been created. \helpref{wxList}{wxlist}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Remarks} There is only one instance of this class: {\bf wxTheBrushList}. Use @@ -314,12 +336,12 @@ Used internally by wxWindows to add a brush to the list. \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. -\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.