rename UpdatePulse() to Pulse() (forgot to commit with the rest of the changes)

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

diff --git a/docs/latex/wx/object.tex b/docs/latex/wx/object.tex
index 1cce58e408917ff84a86b3ace116b680db886f3c..d7c65cee43e9b72401d98cee74c39ff70226c0db 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,13 +22,15 @@ wxPen, wxBitmap and others.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxObject::wxObject}\label{wxobjectconstr}
+\membersection{wxObject::wxObject}\label{wxobjectctor}
 
 \func{}{wxObject}{\void}
 
-Default constructor.
+\func{}{wxObject}{\param{const wxObject\&}{ other}}
 
-\membersection{wxObject::\destruct{wxObject}}
+Default and copy constructors.
+
+\membersection{wxObject::\destruct{wxObject}}\label{wxobjectdtor}
 
 \func{}{wxObject}{\void}
 
@@ -52,21 +54,25 @@ Pointer to an object which is the object's reference-counted data.
 
 \func{void}{Dump}{\param{ostream\&}{ stream}}
 
-A virtual function that should be redefined by derived classes to allow dumping of
+A virtual function that may be redefined by derived classes to allow dumping of
 memory states.
 
+This function is only defined in debug build and doesn't exist at all if
+{\tt \_\_WXDEBUG\_\_} is not defined.
+
 \wxheading{Parameters}
 
 \docparam{stream}{Stream on which to output dump information.}
 
 \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.
+call the Dump member of the class's base class to allow all information to be
+dumped.
 
-The implementation of this function just writes the class name of the object.
-If DEBUG is undefined or zero, the implementation is empty.
+The implementation of this function in wxObject just writes the class name of
+the object.
 
 \membersection{wxObject::GetClassInfo}\label{wxobjectgetclassinfo}
 
@@ -101,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}
@@ -164,7 +170,7 @@ The {\bf m\_refData} member is set to NULL.
 \func{void *}{new}{\param{size\_t }{size}, \param{const wxString\& }{filename = NULL}, \param{int}{ lineNum = 0}}
 
 The {\it new} operator is defined for debugging versions of the library only, when
-the identifier DEBUG is defined and is more than zero. It takes over memory allocation, allowing
+the identifier \_\_WXDEBUG\_\_ is defined. It takes over memory allocation, allowing
 wxDebugContext operations.
 
 \membersection{wxObject::operator delete}\label{wxobjectdelete}
@@ -172,7 +178,7 @@ wxDebugContext operations.
 \func{void}{delete}{\param{void }{buf}}
 
 The {\it delete} operator is defined for debugging versions of the library only, when
-the identifier DEBUG is defined and is more than zero. It takes over memory deallocation, allowing
+the identifier \_\_WXDEBUG\_\_ is defined. It takes over memory deallocation, allowing
 wxDebugContext operations.
 
 \section{\class{wxObjectRefData}}\label{wxobjectrefdata}
@@ -191,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.