add wxSYS_DCLICK_TIME system metric constant; use it for the generic list control...

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

diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex
index 08b3f0cfbf248258f011dc661831e676f36182e0..76826adf6addf81dc15f6631e56c9df0be6ed41a 100644 (file)
--- a/docs/latex/wx/brush.tex
+++ b/docs/latex/wx/brush.tex
@@ -24,6 +24,10 @@ style.
 
 <wx/brush.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \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}.
 
-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.
@@ -78,7 +83,7 @@ data using the reference counting, are not affected.
 
 \func{}{wxBrush}{\void}
 
-Default constructor. The brush will be uninitialised, and \helpref{wxBrush::Ok}{wxbrushok} will
+Default constructor. The brush will be uninitialised, and \helpref{wxBrush:IsOk}{wxbrushisok} will
 return false.
 
 \func{}{wxBrush}{\param{const wxColour\&}{ colour}, \param{int}{ style = {\tt wxSOLID}}}
@@ -95,7 +100,7 @@ Constructs a stippled brush using a bitmap.
 
 \func{}{wxBrush}{\param{const wxBrush\&}{ brush}}
 
-Copy constructor. This uses reference counting so is a cheap operation.
+Copy constructor, uses \helpref{reference counting}{trefcount}.
 
 \wxheading{Parameters}
 
@@ -135,12 +140,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
@@ -163,7 +166,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:IsOk}{wxbitmapisok} returns false).
 
 \wxheading{See also}
 
@@ -206,9 +209,9 @@ Returns true if the style of the brush is any of hatched fills.
 \helpref{wxBrush::GetStyle}{wxbrushgetstyle}
 
 
-\membersection{wxBrush::Ok}\label{wxbrushok}
+\membersection{wxBrush::IsOk}\label{wxbrushisok}
 
-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}
 
 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
@@ -293,26 +296,24 @@ Sets the brush style.
 
 \func{wxBrush\&}{operator $=$}{\param{const wxBrush\& }{brush}}
 
-Assignment operator, using reference counting. Returns a reference
-to `this'.
+Assignment operator, using \helpref{reference counting}{trefcount}.
 
 
 \membersection{wxBrush::operator $==$}\label{wxbrushequals}
 
 \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}
 
@@ -320,13 +321,16 @@ A brush list is a list containing all brushes which have been created.
 
 \wxheading{Derived from}
 
-\helpref{wxList}{wxlist}\\
-\helpref{wxObject}{wxobject}
+\helpref{wxList}{wxlist}
 
 \wxheading{Include files}
 
 <wx/gdicmn.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Remarks}
 
 There is only one instance of this class: {\bf wxTheBrushList}.  Use
@@ -371,13 +375,6 @@ Constructor. The application should not construct its own brush list:
 use the object pointer {\bf wxTheBrushList}.
 
 
-\membersection{wxBrushList::AddBrush}\label{wxbrushlistaddbrush}
-
-\func{void}{AddBrush}{\param{wxBrush *}{brush}}
-
-Used internally by wxWidgets to add a brush to the list.
-
-
 \membersection{wxBrushList::FindOrCreateBrush}\label{wxbrushlistfindorcreatebrush}
 
 \func{wxBrush *}{FindOrCreateBrush}{\param{const wxColour\& }{colour}, \param{int}{ style = wxSOLID}}
@@ -392,10 +389,3 @@ to the brush list, and returns it.
 \docparam{style}{Brush style. See \helpref{wxBrush::SetStyle}{wxbrushsetstyle} for a list of styles.}
 
 
-\membersection{wxBrushList::RemoveBrush}\label{wxbrushlistremovebrush}
-
-\func{void}{RemoveBrush}{\param{wxBrush *}{brush}}
-
-Used by wxWidgets to remove a brush from the list.
-
-