added wxMessageQueue class for inter-thread communications

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

diff --git a/docs/latex/wx/object.tex b/docs/latex/wx/object.tex
index 0e2c9d9cf197c8f590a59f8e8048a3b766dd85b9..8d8c6f07a834b2f453a740987b879bc9f8949efe 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 wxWidgets classes.
+This is the root class of many of the 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.
 


@@ -20,6 +20,18 @@ such as wxPen, wxBitmap and others (see \helpref{this list}{refcountlist}).
 \helpref{wxClassInfo}{wxclassinfo}, \helpref{Debugging overview}{debuggingoverview},\rtfsp
 \helpref{wxObjectRefData}{wxobjectrefdata}
 
 \helpref{wxClassInfo}{wxclassinfo}, \helpref{Debugging overview}{debuggingoverview},\rtfsp
 \helpref{wxObjectRefData}{wxobjectrefdata}
 

+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
+
+<wx/object.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxObject::wxObject}\label{wxobjectctor}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxObject::wxObject}\label{wxobjectctor}


@@ -219,6 +231,118 @@ you will need to cast to your own derived class.
 \wxheading{See also}
 
 \helpref{wxObject}{wxobject}
 \wxheading{See also}
 
 \helpref{wxObject}{wxobject}

+\helpref{wxObjectDataPtr<T>}{wxobjectdataptr}
+\helpref{Reference counting}{trefcount}
+
+\wxheading{Derived from}
+
+No base class
+
+\wxheading{Include files}
+
+<wx/object.h>
+
+\wxheading{Example}
+
+\begin{verbatim}
+
+// include file
+
+class MyCar: public wxObject
+{
+public:
+    MyCar() { }
+    MyCar( int price );
+    
+    bool IsOk() const { return m_refData != NULL; }
+
+    bool operator == ( const MyCar& car ) const;
+    bool operator != (const MyCar& car) const { return !(*this == car); }
+
+    void SetPrice( int price );
+    int GetPrice() const;
+
+protected:
+    virtual wxObjectRefData *CreateRefData() const;
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+
+    DECLARE_DYNAMIC_CLASS(MyCar)
+};
+
+
+// implementation
+
+class MyCarRefData: public wxObjectRefData
+{
+public:
+    MyCarRefData()
+    {
+        m_price = 0;
+    }
+
+    MyCarRefData( const MyCarRefData& data )
+        : wxObjectRefData()
+    {
+        m_price = data.m_price;
+    }
+
+    bool operator == (const MyCarRefData& data) const
+    {
+        return m_price == data.m_price;
+    }
+
+    int m_price;
+};
+
+
+#define M_CARDATA ((MyCarRefData *)m_refData)
+
+IMPLEMENT_DYNAMIC_CLASS(MyCar,wxObject)
+
+MyCar::MyCar( int price )
+{
+    m_refData = new MyCarRefData();
+    M_CARDATA->m_price = price;
+}
+
+wxObjectRefData *MyCar::CreateRefData() const
+{
+    return new MyCarRefData;
+}
+
+wxObjectRefData *MyCar::CloneRefData(const wxObjectRefData *data) const
+{
+    return new MyCarRefData(*(MyCarRefData *)data);
+}
+
+bool MyCar::operator == ( const MyCar& car ) const
+{
+    if (m_refData == car.m_refData) return true;
+
+    if (!m_refData || !car.m_refData) return false;
+
+    return ( *(MyCarRefData*)m_refData == *(MyCarRefData*)car.m_refData );
+}
+
+void MyCar::SetPrice( int price )
+{
+    UnShare();
+
+    M_CARDATA->m_price = price;
+}
+
+int MyCar::GetPrice() const
+{
+    wxCHECK_MSG( IsOk(), -1, "invalid car" );
+    
+    return (M_CARDATA->m_price);
+}
+
+\end{verbatim}
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}