X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dcbd177f06597f98aae27bf53a4c98b4739102c7..fc2b0e31bbd295eddee3573aed9129166794f8de:/docs/latex/wx/object.tex diff --git a/docs/latex/wx/object.tex b/docs/latex/wx/object.tex index c18b6d6646..e5999513cd 100644 --- a/docs/latex/wx/object.tex +++ b/docs/latex/wx/object.tex @@ -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} @@ -116,6 +116,16 @@ this one or is derived from it. 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}} @@ -165,6 +175,17 @@ The {\bf m\_refData} member is set to NULL. \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}} @@ -197,12 +218,6 @@ you will need to cast to your own derived class. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxObjectRefData::m\_count}\label{wxobjectrefdatamcount} - -\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{wxobjectrefdatactor} @@ -216,4 +231,11 @@ Default constructor. Initialises the {\bf m\_count} member to 1. 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.