GetMenuCount() returns size_t, not int

[wxWidgets.git] / docs / latex / wx / object.tex

diff --git a/docs/latex/wx/object.tex b/docs/latex/wx/object.tex
index d5b0550ef27425eca67d5256d9fb7ee500736a66..0e2c9d9cf197c8f590a59f8e8048a3b766dd85b9 100644 (file)
--- 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}
@@ -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}}
@@ -181,6 +202,10 @@ The {\it delete} operator is defined for debugging versions of the library only,
 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
@@ -197,23 +222,41 @@ you will need to cast to your own derived class.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxObjectRefData::m\_count}
 
-\member{int}{m\_count}
+\membersection{wxObjectRefData::wxObjectRefData}\label{wxobjectrefdatactor}
+
+\func{}{wxObjectRefData}{\void}
 
-Reference count. When this goes to zero during a \helpref{wxObject::UnRef}{wxobjectunref}, an object
-can delete the {\bf wxObjectRefData} object.
+Default constructor. Initialises the internal reference count to 1.
 
-\membersection{wxObjectRefData::wxObjectRefData}\label{wxobjectrefdataconstr}
+\membersection{wxObjectRefData::\destruct{wxObjectRefData}}\label{wxobjectrefdatadtor}
 
 \func{}{wxObjectRefData}{\void}
 
-Default constructor. Initialises the {\bf m\_count} member to 1.
+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::\destruct{wxObjectRefData}}
+\membersection{wxObjectRefData::GetRefCount}\label{wxobjectrefdatagetrefcount}
 
-\func{}{wxObjectRefData}{\void}
+\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}
 
-Destructor.
+\func{void}{IncRef}{\void}
 
+Increments the reference count associated with this shared data.