add wxXLocale class and wxIsxxx_l() and wxToxxx_l() functions (heavily modified and...

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

diff --git a/docs/latex/wx/weakref.tex b/docs/latex/wx/weakref.tex
index de989942c5ced57d3953f5ffa07f868d8d68a511..ad01dcf198fe12c86adac69ffeb0575699fc2938 100644 (file)
--- a/docs/latex/wx/weakref.tex
+++ b/docs/latex/wx/weakref.tex
@@ -6,18 +6,17 @@ such as \helpref{wxEvtHandler}{wxevthandler}, \helpref{wxWindow}{wxwindow} and
 pointer, but when the object pointed is destroyed, the weak reference is
 automatically reset to a NULL pointer. 
 
-wxWeakref<T> can be used whenever one must keep a pointer to an object 
-that does not directly own, and that may be destroyed before the object 
+wxWeakRef<T> can be used whenever one must keep a pointer to an object 
+that one does not directly own, and that may be destroyed before the object
 holding the reference. 
 
-wxWeakref<T> is a small object and the mechanism behind it is fast 
+wxWeakRef<T> is a small object and the mechanism behind it is fast 
 (\textbf{O(1)}). So the overall cost of using it is small. 
 
 
 \wxheading{Example}
 
 \begin{verbatim}
-    wxWindow *parent = /* Get parent window from somewhere */;
     wxWindow *wnd = new wxWindow( parent, wxID_ANY, "wxWindow" );
     wxWeakRef<wxWindow> wr = wnd;  
     wxWindowRef wr2 = wnd;        // Same as above, but using a typedef
@@ -31,9 +30,8 @@ wxWeakref<T> is a small object and the mechanism behind it is fast
     wxASSERT( wr==NULL );
 \end{verbatim}
 
-wxWeakref<T> works for any objects that are derived from 
-\helpref{wxTrackableBase}{wxtrackablebase} or \helpref{wxTrackable}{wxtrackable}.
-By default, wxEvtHandler and wxWindow derive from wxTrackableBase. However, 
+wxWeakRef<T> works for any objects that are derived from \helpref{wxTrackable}{wxtrackable}.
+By default, wxEvtHandler and wxWindow derive from wxTrackable. However, 
 wxObject does not, so types like \helpref{wxFont}{wxfont} and 
 \helpref{wxColour}{wxcolour} are not trackable. The example below shows how to
 create a wxObject derived class that is trackable: 
@@ -44,18 +42,11 @@ create a wxObject derived class that is trackable:
     }; 
 \end{verbatim}
 
-\textbf{Note:} Custom trackable objects should derive from wxTrackable 
-if one wants to reference them from a \texttt{wxWeakRef<wxObject>}. The 
-difference between the two base classes is that wxTrackableBase 
-has no virtual member functions (no VTable), and thus cannot be detected
-through \texttt{dynamic\_cast<>}.
-
 \wxheading{Predefined types}
 
 The following types of weak references are predefined: 
 
 \begin{verbatim}
-typedef wxWeakRef<wxObject>      wxObjectRef;
 typedef wxWeakRef<wxEvtHandler>  wxEvtHandlerRef;
 typedef wxWeakRef<wxWindow>      wxWindowRef;
 \end{verbatim}
@@ -105,15 +96,12 @@ Destructor.
 
 Returns pointer to the tracked object or NULL.
 
-\membersection{wxWeakRef<T>::operator unspecified\_bool\_type}\label{wxweakrefoperatorbool}
-
-\constfunc{}{operator unspecified\_bool\_type}{\void}
+\membersection{wxWeakRef<T>::operator T*}\label{wxweakrefoperatorconvt}
 
-Conversion to a boolean expression (in a variant which is not 
-convertable to anything but a boolean expression). If this class
-contains a valid pointer it will return {\it true}, if it contains
-a NULL pointer it will return {\it false}.
+\constfunc{T*}{operator*}{\void}
 
+Implicit conversion to T*. Returns pointer to the tracked
+object or NULL.
 
 \membersection{wxWeakRef<T>::operator*}\label{wxweakrefoperatorreft}
 
@@ -134,7 +122,7 @@ method will cause an assert in debug mode.
 
 \membersection{wxWeakRef<T>::operator=}\label{wxweakrefoperatorassign}
 
-\func{T* operator}{operator=}{\param{T* }{pobj}}
+\func{T*}{operator=}{\param{T* }{pobj}}
 
 Releases the currently tracked object and starts tracking {\it pobj}.
 A weak reference may be reset by passing {\it NULL} as {\it pobj}.
@@ -142,12 +130,19 @@ A weak reference may be reset by passing {\it NULL} as {\it pobj}.
 
 \membersection{wxWeakRef<T>::operator =}\label{wxweakrefoperatorassign2}
 
-\func{T* operator}{operator =}{\param{wxWeakRef<T>\& }{wr}}
+\func{T*}{operator =}{\param{wxWeakRef<T>\& }{wr}}
 
 Release currently tracked object and start tracking the same object as
 the wxWeakRef {\it wr}.
 
 
+\membersection{wxWeakRef<T>::Release}\label{wxweakrefrelease}
+
+\func{void}{Release}{\void}
+
+Release currently tracked object and rests object reference.
+
+
 \membersection{wxWeakRef<T>::OnObjectDestroy}\label{wxweakrefonobjectdestroy}
 
 \func{virtual void}{OnObjectDestroy}{\void}