X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a91225b27b4416488d299ef10053bb822e6a9bf4..19f6bff4484b97ef036a793820eb30c0a6df92b5:/docs/latex/wx/brush.tex diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex index 63faaac73e..645030f216 100644 --- a/docs/latex/wx/brush.tex +++ b/docs/latex/wx/brush.tex @@ -60,10 +60,11 @@ application may wish to get a pointer to a brush by using the global list of brushes {\bf wxTheBrushList}, and calling the member function \rtfsp{\bf FindOrCreateBrush}. -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. Once one wxBrush object changes its data it will create its -own brush data internally so that other brushes, which previously shared the +This class uses \helpref{reference counting and copy-on-write}{trefcount} +internally so that assignments between two instances of this class are very +cheap. You can therefore use actual objects instead of pointers without +efficiency problems. If an instance of this class is changed it will create +its own data internally so that other instances, which previously shared the data using the reference counting, are not affected. %TODO: an overview for wxBrush. @@ -135,12 +136,10 @@ If a stipple brush is created, the brush style will be set to wxSTIPPLE. \func{}{\destruct{wxBrush}}{\void} Destructor. +See \helpref{reference-counted object destruction}{refcountdestruct} for more info. \wxheading{Remarks} -The destructor may not delete the underlying brush object of the native windowing -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 wxWidgets cannot know if a pointer to the brush object is stored in an @@ -300,18 +299,17 @@ Assignment operator, using \helpref{reference counting}{trefcount}. \func{bool}{operator $==$}{\param{const wxBrush\& }{brush}} -Equality operator. Two brushes are equal if they contain pointers -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. +Equality operator. +See \helpref{reference-counted object comparison}{refcountequality} for more info. \membersection{wxBrush::operator $!=$}\label{wxbrushnotequals} \func{bool}{operator $!=$}{\param{const wxBrush\& }{brush}} -Inequality operator. Two brushes are not equal if they contain pointers -to different underlying brush data. It does not compare each attribute. +Inequality operator. +See \helpref{reference-counted object comparison}{refcountequality} for more info. + \section{\class{wxBrushList}}\label{wxbrushlist}