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 a93d8e02d1919886e98070b6165b7b4ad2013a6d..d7c65cee43e9b72401d98cee74c39ff70226c0db 100644 (file)
--- a/docs/latex/wx/object.tex
+++ b/docs/latex/wx/object.tex
@@ -1,6 +1,6 @@
 \section{\class{wxObject}}\label{wxobject}
 
 \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.
 
 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.
 
 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}
 
 
 \wxheading{See also}
 


@@ -22,13 +22,15 @@ wxPen, wxBitmap and others.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxObject::wxObject}\label{wxobjectconstr}
+\membersection{wxObject::wxObject}\label{wxobjectctor}

 
 \func{}{wxObject}{\void}
 
 
 \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}
 
 
 \func{}{wxObject}{\void}
 


@@ -48,32 +50,29 @@ Pointer to an object which is the object's reference-counted data.
 \helpref{wxObject::GetRefData}{wxobjectgetrefdata},\rtfsp
 \helpref{wxObjectRefData}{wxobjectrefdata}
 
 \helpref{wxObject::GetRefData}{wxobjectgetrefdata},\rtfsp
 \helpref{wxObjectRefData}{wxobjectrefdata}
 

-\membersection{wxObject::CopyObject}\label{wxobjectcopyobject}
-
-\func{virtual void}{CopyObject}{\param{wxObject\&}{ object\_dest}}
-
-Create a copy of this object in object\_dest. Must perform a full copy of self
-so that object\_dest will be valid after this object is deleted
-

 \membersection{wxObject::Dump}\label{wxobjectdump}
 
 \func{void}{Dump}{\param{ostream\&}{ stream}}
 
 \membersection{wxObject::Dump}\label{wxobjectdump}
 
 \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.
 
 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}
 
 \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
 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
-in debug build (\_\_WXDEBUG\_\_ defined), otherwise it does nothing.
+The implementation of this function in wxObject just writes the class name of
+the object.

 
 \membersection{wxObject::GetClassInfo}\label{wxobjectgetclassinfo}
 
 
 \membersection{wxObject::GetClassInfo}\label{wxobjectgetclassinfo}
 


@@ -108,7 +107,7 @@ by using the CLASSINFO macro.}
 
 \wxheading{Return value}
 
 
 \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}
 this one or is derived from it.
 
 \wxheading{Example}


@@ -198,23 +197,24 @@ you will need to cast to your own derived class.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \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.
 
 
 \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.
 
 
 \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.