]>
git.saurik.com Git - wxWidgets.git/blob - interface/weakref.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxWeakRefDynamic<T>
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
12 wxWeakRefDynamicT is a template class for weak references that is used in
13 the same way as wxWeakRefT. The only difference is that wxWeakRefDynamic
14 defaults to using @c dynamic_cast for establishing the object
15 reference (while wxWeakRef defaults to @c static_cast).
17 So, wxWeakRef will detect a type mismatch during compile time and will
18 have a little better run-time performance. The role of wxWeakRefDynamic
19 is to handle objects which derived type one does not know.
21 @note wxWeakRefT selects an implementation based on the static type
22 of T. If T does not have wxTrackable statically, it defaults to to a mixed-
23 mode operation, where it uses @c dynamic_cast as the last measure (if
24 available from the compiler and enabled when building wxWidgets).
26 For general cases, wxWeakRefT is the better choice.
28 For API documentation, see: wxWeakRef
33 class wxWeakRefDynamic
<T
>
44 wxWeakRef is a template class for weak references to wxWidgets objects,
45 such as wxEvtHandler, wxWindow and
46 wxObject. A weak reference behaves much like an ordinary
47 pointer, but when the object pointed is destroyed, the weak reference is
48 automatically reset to a @NULL pointer.
50 wxWeakRefT can be used whenever one must keep a pointer to an object
51 that one does not directly own, and that may be destroyed before the object
52 holding the reference.
54 wxWeakRefT is a small object and the mechanism behind it is fast
55 (@b O(1)). So the overall cost of using it is small.
60 @see wxSharedPtr, wxScopedPtr
66 Constructor. The weak reference is initialized to @e pobj.
68 wxWeakRefT(T
* pobj
= NULL
);
76 Called when the tracked object is destroyed. Be default sets
77 internal pointer to @NULL.
79 virtual void OnObjectDestroy();
82 Release currently tracked object and rests object reference.
87 Returns pointer to the tracked object or @NULL.
92 Release currently tracked object and start tracking the same object as
95 T
* operator =(wxWeakRef
<T
>& wr
);
98 Implicit conversion to T*. Returns pointer to the tracked
101 T
* operator*() const;
104 Returns a reference to the tracked object. If the internal pointer is @NULL
105 this method will cause an assert in debug mode.
110 Smart pointer member access. Returns a pointer to the
111 tracked object. If the internal pointer is @NULL this
112 method will cause an assert in debug mode.
117 Releases the currently tracked object and starts tracking @e pobj.
118 A weak reference may be reset by passing @e @NULL as @e pobj.
120 T
* operator=(T
* pobj
);