]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/brush.tex
Added periods
[wxWidgets.git] / docs / latex / wx / brush.tex
index 63faaac73ea44076f8d17baa7bf458bc43e4707d..7ff8359c02e60e78644c38cced111d3fdbd1343b 100644 (file)
@@ -24,6 +24,10 @@ style.
 
 <wx/brush.h>
 
 
 <wx/brush.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Predefined objects}
 
 Objects:
 \wxheading{Predefined objects}
 
 Objects:
@@ -60,10 +64,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}.
 
 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.
 data using the reference counting, are not affected.
 
 %TODO: an overview for wxBrush.
@@ -135,12 +140,10 @@ If a stipple brush is created, the brush style will be set to wxSTIPPLE.
 \func{}{\destruct{wxBrush}}{\void}
 
 Destructor.
 \func{}{\destruct{wxBrush}}{\void}
 
 Destructor.
+See \helpref{reference-counted object destruction}{refcountdestruct} for more info.
 
 \wxheading{Remarks}
 
 
 \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
 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 +303,17 @@ Assignment operator, using \helpref{reference counting}{trefcount}.
 
 \func{bool}{operator $==$}{\param{const wxBrush\& }{brush}}
 
 
 \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}}
 
 
 
 \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}
 
 
 \section{\class{wxBrushList}}\label{wxbrushlist}
 
@@ -326,6 +328,10 @@ A brush list is a list containing all brushes which have been created.
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \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