Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix LaTeX error (escape underscores); don't abuse bold face

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51117 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2008-01-08 19:30:34 +00:00
parent 60f0cf4e12
commit b3a029f0bb
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/latex/wx/weakref.tex
View File

@@ -1,16 +1,17 @@
\section{\class{wxWeakRef<T>}}\label{wxweakref} \section{\class{wxWeakRef<T>}}\label{wxweakref}
{\bf wxWeakRef} is a template class for weak references to wxWidgets objects, wxWeakRef is a template class for weak references to wxWidgets objects,
such as {\bf wxEvtHandler}, {\bf wxWindow} and {\bf wxObject}. A weak such as \helpref{wxEvtHandler}{wxevthandler}, \helpref{wxWindow}{wxwindow} and
reference behaves much like an ordinary pointer, but when the object pointed \helpref{wxObject}{wxobject}. A weak reference behaves much like an ordinary
is destroyed, the weak reference is automatically reset to a NULL pointer. 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 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 that does not directly own, and that may be destroyed before the object
holding the reference. 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
({\bf O(1)}). So the overall cost of using it is small. (\textbf{O(1)}). So the overall cost of using it is small.
\wxheading{Example} \wxheading{Example}
@@ -33,9 +34,9 @@ wxWeakref<T> is a small object and the mechanism behind it is fast
wxWeakref<T> works for any objects that are derived from wxWeakref<T> works for any objects that are derived from
\helpref{wxTrackableBase}{wxtrackablebase} or \helpref{wxTrackable}{wxtrackable}. \helpref{wxTrackableBase}{wxtrackablebase} or \helpref{wxTrackable}{wxtrackable}.
By default, wxEvtHandler and wxWindow derive from wxTrackableBase. However, By default, wxEvtHandler and wxWindow derive from wxTrackableBase. However,
wxObject does not, so types like {\bf wxFont} and wxObject does not, so types like \helpref{wxFont}{wxfont} and
{\bf wxColour} are not trackable. The example below shows how to create a \helpref{wxColour}{wxcolour} are not trackable. The example below shows how to
wxObject derived class that is trackable: create a wxObject derived class that is trackable:
\begin{verbatim} \begin{verbatim}
class wxMyTrackableObject : public wxObject, public wxTrackable { class wxMyTrackableObject : public wxObject, public wxTrackable {
@@ -43,11 +44,11 @@ wxObject derived class that is trackable:
}; };
\end{verbatim} \end{verbatim}
{\bf Note:} Custom trackable objects should derive from wxTrackable \textbf{Note:} Custom trackable objects should derive from wxTrackable
if one wants to reference them from a {\bf wxWeakRef<wxObject>}. The if one wants to reference them from a \texttt{wxWeakRef<wxObject>}. The
difference between the two base classes is that wxTrackableBase difference between the two base classes is that wxTrackableBase
has no virtual member functions (no VTable), and thus cannot be detected has no virtual member functions (no VTable), and thus cannot be detected
through {\bf dynamic_cast<>}. through \texttt{dynamic\_cast<>}.
\wxheading{Predefined types} \wxheading{Predefined types}