\section{\class{wxObject}}\label{wxobject}
-This is the root class of all wxWindows classes.
+This is the root class of all wxWidgets classes.
It declares a virtual destructor which ensures that
destructors get called for all derived class objects where necessary.
of {\bf new} and {\bf delete}, which can help trace memory allocation
and deallocation problems.
-wxObject can be used to implement reference counted objects, such as
-wxPen, wxBitmap and others.
+wxObject can be used to implement \helpref{reference counted}{trefcount} objects,
+such as wxPen, wxBitmap and others (see \helpref{this list}{refcountlist}).
\wxheading{See also}
\helpref{wxClassInfo}{wxclassinfo}, \helpref{Debugging overview}{debuggingoverview},\rtfsp
\helpref{wxObjectRefData}{wxobjectrefdata}
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
+
+<wx/object.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxObject::wxObject}\label{wxobjectconstr}
+\membersection{wxObject::wxObject}\label{wxobjectctor}
\func{}{wxObject}{\void}
Default and copy constructors.
-\membersection{wxObject::\destruct{wxObject}}
+\membersection{wxObject::\destruct{wxObject}}\label{wxobjectdtor}
\func{}{wxObject}{\void}
\wxheading{Remarks}
-Currently wxWindows does not define Dump for derived classes, but
+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.
\wxheading{Return value}
-TRUE if the class represented by {\it info} is the same class as
+true if the class represented by {\it info} is the same class as
this one or is derived from it.
\wxheading{Example}
bool tmp = obj->IsKindOf(CLASSINFO(wxFrame));
\end{verbatim}
+\membersection{wxObject::IsSameAs}\label{wxobjectissameas}
+
+\func{bool}{IsSameAs}{\param{const wxObject\& }{ obj}}
+
+Returns \true if this object has the same data pointer as \arg{obj}. Notice
+that \true is returned if the data pointers are \NULL in both objects.
+
+This function only does a \emph{shallow} comparison, i.e. it doesn't compare
+the objects pointed to by the data pointers of these objects.
+
\membersection{wxObject::Ref}\label{wxobjectref}
\func{void}{Ref}{\param{const wxObject\& }{clone}}
\helpref{wxObject::SetRefData}{wxobjectsetrefdata}, \helpref{wxObject::GetRefData}{wxobjectgetrefdata},\rtfsp
\helpref{wxObjectRefData}{wxobjectrefdata}
+\membersection{wxObject::UnShare}\label{wxobjectunshare}
+
+\func{void}{UnShare}{\void}
+
+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.
+
+
\membersection{wxObject::operator new}\label{wxobjectnew}
\func{void *}{new}{\param{size\_t }{size}, \param{const wxString\& }{filename = NULL}, \param{int}{ lineNum = 0}}
the identifier \_\_WXDEBUG\_\_ is defined. It takes over memory deallocation, allowing
wxDebugContext operations.
+
+
+%% wxObjectRefData
+
\section{\class{wxObjectRefData}}\label{wxobjectrefdata}
This class is used to store reference-counted data. Derive classes from this to
\helpref{wxObject}{wxobject}
-\latexignore{\rtfignore{\wxheading{Members}}}
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
-\membersection{wxObjectRefData::m\_count}
+<wx/object.h>
-\member{int}{m\_count}
+\wxheading{Library}
-Reference count. When this goes to zero during a \helpref{wxObject::UnRef}{wxobjectunref}, an object
-can delete the {\bf wxObjectRefData} object.
+\helpref{wxBase}{librarieslist}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxObjectRefData::wxObjectRefData}\label{wxobjectrefdataconstr}
+
+\membersection{wxObjectRefData::wxObjectRefData}\label{wxobjectrefdatactor}
\func{}{wxObjectRefData}{\void}
-Default constructor. Initialises the {\bf m\_count} member to 1.
+Default constructor. Initialises the internal reference count to 1.
-\membersection{wxObjectRefData::\destruct{wxObjectRefData}}
+\membersection{wxObjectRefData::\destruct{wxObjectRefData}}\label{wxobjectrefdatadtor}
\func{}{wxObjectRefData}{\void}
-Destructor.
+Destructor. It's declared {\tt protected} so that wxObjectRefData instances will never
+be destroyed directly but only as result of a \helpref{DecRef}{wxobjectrefdatadecref} call.
+
+\membersection{wxObjectRefData::GetRefCount}\label{wxobjectrefdatagetrefcount}
+
+\constfunc{int}{GetRefCount}{\void}
+
+Returns the reference count associated with this shared data.
+When this goes to zero during a \helpref{DecRef}{wxobjectrefdatadecref} call, the object
+will auto-free itself.
+
+\membersection{wxObjectRefData::DecRef}\label{wxobjectrefdatadecref}
+
+\func{void}{DecRef}{\void}
+
+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.
+
+\membersection{wxObjectRefData::IncRef}\label{wxobjectrefdataincref}
+
+\func{void}{IncRef}{\void}
+Increments the reference count associated with this shared data.
projects / wxWidgets.git / blobdiff