Decrements the reference count associated with this shared data and, if it
reaches zero,
destroys this instance of wxObjectRefData releasing its memory.
-
Please note that after calling this function, the caller should absolutely
avoid to use
the pointer to this instance since it may not be valid anymore.
@category{rtti}
@seealso
- wxClassInfo, @ref overview_debuggingoverview "Debugging overview",
- wxObjectRefData
+ wxClassInfo, @ref overview_debuggingoverview, wxObjectRefData
*/
class wxObject
{
/**
A virtual function that may be redefined by derived classes to allow dumping of
memory states.
-
This function is only defined in debug build and doesn't exist at all if
@c __WXDEBUG__ is not defined.
@param stream
- Stream on which to output dump information.
+ Stream on which to output dump information.
@remarks Currently wxWidgets does not define Dump for derived classes,
- but programmers may wish to use it for their own
- applications. Be sure to call the Dump member of the
- class's base class to allow all information to be
- dumped.
+ but programmers may wish to use it for their own
+ applications. Be sure to call the Dump member of the
+ class's base class to allow all information to be
+ dumped.
*/
void Dump(ostream& stream);
This virtual function is redefined for every class that requires run-time
type information, when using DECLARE_CLASS macros.
*/
- wxClassInfo * GetClassInfo();
+ wxClassInfo* GetClassInfo();
/**
Returns the @b m_refData pointer.
- @sa Ref(), UnRef(), wxObject::m_refData, SetRefData(),
- wxObjectRefData
+ @see Ref(), UnRef(), wxObject::m_refData, SetRefData(),
+ wxObjectRefData
*/
wxObjectRefData* GetRefData();
the given class.
@param info
- A pointer to a class information object, which may be obtained
- by using the CLASSINFO macro.
+ A pointer to a class information object, which may be obtained
+ by using the CLASSINFO macro.
@returns @true if the class represented by info is the same class as this
- one or is derived from it.
+ one or is derived from it.
*/
- bool IsKindOf(wxClassInfo * info);
+ bool IsKindOf(wxClassInfo* info);
/**
Returns @true if this object has the same data pointer as @e obj. Notice
that @true is returned if the data pointers are @NULL in both objects.
-
This function only does a shallow comparison, i.e. it doesn't compare
the objects pointed to by the data pointers of these objects.
*/
Makes this object refer to the data in @e clone.
@param clone
- The object to 'clone'.
+ The object to 'clone'.
@remarks First this function calls UnRef() on itself to decrement
- (and perhaps free) the data it is currently referring
- to.
+ (and perhaps free) the data it is currently referring
+ to.
- @sa UnRef(), wxObject::m_refData, SetRefData(),
- GetRefData(), wxObjectRefData
+ @see UnRef(), wxObject::m_refData, SetRefData(),
+ GetRefData(), wxObjectRefData
*/
-#define void Ref(const wxObject& clone) /* implementation is private */
+ void Ref(const wxObject& clone);
/**
Sets the @b m_refData pointer.
- @sa Ref(), UnRef(), wxObject::m_refData, GetRefData(),
- wxObjectRefData
+ @see Ref(), UnRef(), wxObject::m_refData, GetRefData(),
+ wxObjectRefData
*/
void SetRefData(wxObjectRefData* data);
deletes the data.
The @b m_refData member is set to @NULL.
- @sa Ref(), wxObject::m_refData, SetRefData(),
- GetRefData(), wxObjectRefData
+ @see Ref(), wxObject::m_refData, SetRefData(),
+ GetRefData(), wxObjectRefData
*/
void UnRef();
/**
Ensure that this object's data is not shared with any other object.
-
if we have no
data, it is created using CreateRefData() below, if we have shared data
it is copied using CloneRefData(), otherwise nothing is done.
/**
wxObjectRefData* m_refData
-
Pointer to an object which is the object's reference-counted data.
- @sa Ref(), UnRef(), SetRefData(),
- GetRefData(), wxObjectRefData
+ @see Ref(), UnRef(), SetRefData(),
+ GetRefData(), wxObjectRefData
*/
the identifier __WXDEBUG__ is defined. It takes over memory allocation, allowing
wxDebugContext operations.
*/
- void * new(size_t size, const wxString& filename = @NULL,
- int lineNum = 0);
+ void* new(size_t size, const wxString& filename = NULL,
+ int lineNum = 0);
};
objects of this
class, so there is no need to create such objects explicitly in an application.
*/
- wxClassInfo(const wxChar * className,
- const wxClassInfo * baseClass1,
- const wxClassInfo * baseClass2,
+ wxClassInfo(const wxChar* className,
+ const wxClassInfo* baseClass1,
+ const wxClassInfo* baseClass2,
int size, wxObjectConstructorFn fn);
/**
/**
Finds the wxClassInfo object for a class of the given string name.
*/
- static wxClassInfo * FindClass(wxChar * name);
+ static wxClassInfo* FindClass(wxChar* name);
/**
Returns the name of the first base class (@NULL if none).
*/
- wxChar * GetBaseClassName1();
+ wxChar* GetBaseClassName1();
/**
Returns the name of the second base class (@NULL if none).
*/
- wxChar * GetBaseClassName2();
+ wxChar* GetBaseClassName2();
/**
Returns the string form of the class name.
*/
- wxChar * GetClassName();
+ wxChar* GetClassName();
/**
Returns the size of the class.
//@{
/**
This copy constructor increases the count of the reference
- counted object to which @e tocopy points and then this
+ counted object to which @a tocopy points and then this
class will point to, as well.
*/
- wxObjectDataPtrT(T* ptr = @NULL);
+ wxObjectDataPtrT(T* ptr = NULL);
wxObjectDataPtrT(const wxObjectDataPtr<T>& tocopy);
//@}
Used inside a class declaration to declare that the class should be
made known to the class hierarchy, but objects of this class cannot be created
dynamically. The same as DECLARE_CLASS.
-
Example:
+
@code
class wxCommand: public wxObject
{
/**
Returns a pointer to the wxClassInfo object associated with this class.
*/
-#define wxClassInfo * CLASSINFO() /* implementation is private */
+#define wxClassInfo* CLASSINFO() /* implementation is private */
/**
Same as @c reinterpret_castT(x) if the compiler supports reinterpret cast or
@c (T)x for old compilers.
- @sa wx_const_cast, wx_static_cast
+ @see wx_const_cast, wx_static_cast
*/
T wx_reinterpret_cast();
This macro expands into @c const_castclassname *(ptr) if the compiler
supports @e const_cast or into an old, C-style cast, otherwise.
- @sa wx_const_cast, wxDynamicCast, wxStaticCast
+ @see wx_const_cast, wxDynamicCast, wxStaticCast
*/
-classname * wxConstCast();
+classname* wxConstCast();
/**
Used in a C++ implementation file to complete the declaration of
a class that has run-time type information. The same as IMPLEMENT_CLASS.
-
Example:
+
@code
IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
tests whether @c this pointer is non-@NULL which is always @true), so
this macro should be used to avoid them.
- @sa wxDynamicCast
+ @see wxDynamicCast
*/
-classname * wxDynamicCastThis();
+classname* wxDynamicCastThis();
/**
Used in a C++ implementation file to complete the declaration of
registered with the dynamic class system using DECLARE... and IMPLEMENT...
macros.
*/
-wxObject * wxCreateDynamicObject(const wxString& className);
+wxObject* wxCreateDynamicObject(const wxString& className);
/**
Used inside a class declaration to make the class known to wxWidgets RTTI
creatable from run-time type information. Notice that this implies that the
class should have a default constructor, if this is not the case consider using
DECLARE_CLASS.
-
Example:
+
@code
class wxFrame: public wxWindow
{
the cast it to the type @e T and not to @c T * and also the order of
arguments is the same as for the standard cast.
- @sa wx_reinterpret_cast, wx_static_cast
+ @see wx_reinterpret_cast, wx_static_cast
*/
T wx_const_cast();
the pointer is of this type (the check is done during the run-time) or
@NULL otherwise. Usage of this macro is preferred over obsoleted
wxObject::IsKindOf() function.
-
The @e ptr argument may be @NULL, in which case @NULL will be
returned.
-
Example:
+
@code
wxWindow *win = wxWindow::FindFocus();
wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
}
@endcode
- @sa @ref overview_runtimeclassoverview "RTTI overview", wxDynamicCastThis,
- wxConstCast, wxStaticCast
+ @see @ref overview_runtimeclassoverview "RTTI overview", wxDynamicCastThis,
+ wxConstCast, wxStaticCast
*/
-classname * wxDynamicCast();
+classname* wxDynamicCast();
/**
This is defined in debug mode to be call the redefined new operator
with filename and line number arguments. The definition is:
+
@code
#define WXDEBUG_NEW new(__FILE__,__LINE__)
@endcode
result if @c wxDynamicCast(ptr, classname) == @NULL) and then returns the
result of executing an equivalent of @c static_castclassname *(ptr).
- @sa wx_static_cast, wxDynamicCast, wxConstCast
+ @see wx_static_cast, wxDynamicCast, wxConstCast
*/
-classname * wxStaticCast();
+classname* wxStaticCast();
/**
Same as @c static_castT(x) if the compiler supports static cast or
the same as for the standard static cast, i.e. @e T is the full type name and
star is not appended to it.
- @sa wx_const_cast, wx_reinterpret_cast, wx_truncate_cast
+ @see wx_const_cast, wx_reinterpret_cast, wx_truncate_cast
*/
T wx_static_cast();
Used in a C++ implementation file to complete the declaration of
a class that has run-time type information, and whose instances
can be created dynamically.
-
Example:
+
@code
IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
projects / wxWidgets.git / blobdiff