X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eb199c515b63b9241eeb2f711a9250cb45e8060e..8e458bb53997706d4432d2dc0b9b516320709389:/docs/latex/wx/object.tex diff --git a/docs/latex/wx/object.tex b/docs/latex/wx/object.tex index d5b0550ef2..d7c65cee43 100644 --- a/docs/latex/wx/object.tex +++ b/docs/latex/wx/object.tex @@ -1,6 +1,6 @@ \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. @@ -12,8 +12,8 @@ The class contains optional debugging versions 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} @@ -22,7 +22,7 @@ wxPen, wxBitmap and others. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxObject::wxObject}\label{wxobjectconstr} +\membersection{wxObject::wxObject}\label{wxobjectctor} \func{}{wxObject}{\void} @@ -30,7 +30,7 @@ wxPen, wxBitmap and others. Default and copy constructors. -\membersection{wxObject::\destruct{wxObject}} +\membersection{wxObject::\destruct{wxObject}}\label{wxobjectdtor} \func{}{wxObject}{\void} @@ -66,7 +66,7 @@ This function is only defined in debug build and doesn't exist at all if \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. @@ -107,7 +107,7 @@ by using the CLASSINFO macro.} \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} @@ -197,23 +197,24 @@ you will need to cast to your own derived class. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxObjectRefData::m\_count} -\member{int}{m\_count} - -Reference count. When this goes to zero during a \helpref{wxObject::UnRef}{wxobjectunref}, an object -can delete the {\bf wxObjectRefData} object. - -\membersection{wxObjectRefData::wxObjectRefData}\label{wxobjectrefdataconstr} +\membersection{wxObjectRefData::wxObjectRefData}\label{wxobjectrefdatactor} \func{}{wxObjectRefData}{\void} Default constructor. Initialises the {\bf m\_count} member to 1. -\membersection{wxObjectRefData::\destruct{wxObjectRefData}} +\membersection{wxObjectRefData::\destruct{wxObjectRefData}}\label{wxobjectrefdatadtor} \func{}{wxObjectRefData}{\void} Destructor. +\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{wxObject::UnRef}{wxobjectunref}, an object +can delete this {\bf wxObjectRefData} object.