Version: 3.1.2

#include <wx/object.h>

+ Inheritance diagram for wxRefCounter:

Detailed Description

This class is used to manage reference-counting providing a simple interface and a counter.

wxRefCounter can be easily used together with wxObjectDataPtr<T> to ensure that no calls to wxRefCounter::DecRef() are missed - thus avoiding memory leaks.

wxObjectRefData is a typedef to wxRefCounter and is used as the built-in reference counted storage for wxObject-derived classes.

Library:  wxBase
Category:  Runtime Type Information (RTTI)
See also
wxObject, wxObjectRefData, wxObjectDataPtr<T>, Reference Counting

Public Member Functions

 wxRefCounter ()
 Default constructor. More...
 
void DecRef ()
 Decrements the reference count associated with this shared data and, if it reaches zero, destroys this instance of wxRefCounter releasing its memory. More...
 
int GetRefCount () const
 Returns the reference count associated with this shared data. More...
 
void IncRef ()
 Increments the reference count associated with this shared data. More...
 

Protected Member Functions

virtual ~wxRefCounter ()
 Destructor. More...
 

Constructor & Destructor Documentation

virtual wxRefCounter::~wxRefCounter ( )
protectedvirtual

Destructor.

It's declared protected so that wxRefCounter instances will never be destroyed directly but only as result of a DecRef() call.

wxRefCounter::wxRefCounter ( )

Default constructor.

Initialises the internal reference count to 1.

Member Function Documentation

void wxRefCounter::DecRef ( )

Decrements the reference count associated with this shared data and, if it reaches zero, destroys this instance of wxRefCounter 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.

int wxRefCounter::GetRefCount ( ) const

Returns the reference count associated with this shared data.

When this goes to zero during a DecRef() call, the object will auto-free itself.

void wxRefCounter::IncRef ( )

Increments the reference count associated with this shared data.