added wxMessageQueue class for inter-thread communications

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

diff --git a/docs/latex/wx/ddeclint.tex b/docs/latex/wx/ddeclint.tex
index 646420c789cf0975988bc0c716ed696bae42845d..4d1f26a7c3f7e93fa6f1653abcce00c1bbddeff3 100644 (file)
--- a/docs/latex/wx/ddeclint.tex
+++ b/docs/latex/wx/ddeclint.tex
@@ -1,31 +1,40 @@
 \section{\class{wxDDEClient}}\label{wxddeclient}
 
 \section{\class{wxDDEClient}}\label{wxddeclient}
 

-\overview{Interprocess communications overview}{ipcoverview}
-

 A wxDDEClient object represents the client part of a client-server DDE
 A wxDDEClient object represents the client part of a client-server DDE

-(Dynamic Data Exchange) conversation (available in {\it both}\/
-Windows and UNIX).
+(Dynamic Data Exchange) conversation.

 
 To create a client which can communicate with a suitable server,
 you need to derive a class from wxDDEConnection and another from wxDDEClient.
 The custom wxDDEConnection class will intercept communications in
 a `conversation' with a server, and the custom wxDDEServer is required
 
 To create a client which can communicate with a suitable server,
 you need to derive a class from wxDDEConnection and another from wxDDEClient.
 The custom wxDDEConnection class will intercept communications in
 a `conversation' with a server, and the custom wxDDEServer is required

-so that a user-overriden \helpref{wxDDEClient::OnMakeConnection}{wxddeclientonmakeconnection} member can return
+so that a user-overridden \helpref{wxDDEClient::OnMakeConnection}{wxddeclientonmakeconnection} member can return

 a wxDDEConnection of the required class, when a connection is made.
 
 a wxDDEConnection of the required class, when a connection is made.
 

+This DDE-based implementation is
+available on Windows only, but a platform-independent, socket-based version
+of this API is available using \helpref{wxTCPClient}{wxtcpclient}.
+

 \wxheading{Derived from}
 
 \wxheading{Derived from}
 

-wxDDEObject
+wxClientBase\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/dde.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEConnection}{wxddeconnection},
-the chapter on interprocess communication in the user manual, and
-the programs in {\tt samples/ipc}.
+\helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEConnection}{wxddeconnection}, 
+\helpref{Interprocess communications overview}{ipcoverview}

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

-\membersection{wxDDEClient::wxDDEClient}
+\membersection{wxDDEClient::wxDDEClient}\label{wxddeclientctor}

 
 \func{}{wxDDEClient}{\void}
 
 
 \func{}{wxDDEClient}{\void}
 


@@ -33,7 +42,7 @@ Constructs a client object.
 
 \membersection{wxDDEClient::MakeConnection}\label{wxddeclientmakeconnection}
 
 
 \membersection{wxDDEClient::MakeConnection}\label{wxddeclientmakeconnection}
 

-\func{wxDDEConnection *}{MakeConnection}{\param{const wxString\& }{host}, \param{const wxString\& }{service}, \param{const wxString\& }{topic}}
+\func{wxConnectionBase *}{MakeConnection}{\param{const wxString\& }{host}, \param{const wxString\& }{service}, \param{const wxString\& }{topic}}

 
 Tries to make a connection with a server specified by the host
 (machine name under UNIX, ignored under Windows), service name (must
 
 Tries to make a connection with a server specified by the host
 (machine name under UNIX, ignored under Windows), service name (must


@@ -45,23 +54,22 @@ derived connection object.
 
 \membersection{wxDDEClient::OnMakeConnection}\label{wxddeclientonmakeconnection}
 
 
 \membersection{wxDDEClient::OnMakeConnection}\label{wxddeclientonmakeconnection}
 

-\func{wxDDEConnection *}{OnMakeConnection}{\void}
+\func{wxConnectionBase *}{OnMakeConnection}{\void}

 
 The type of \helpref{wxDDEConnection}{wxddeconnection} returned from a \helpref{wxDDEClient::MakeConnection}{wxddeclientmakeconnection} call can
 be altered by deriving the {\bf OnMakeConnection} member to return your
 
 The type of \helpref{wxDDEConnection}{wxddeconnection} returned from a \helpref{wxDDEClient::MakeConnection}{wxddeclientmakeconnection} call can
 be altered by deriving the {\bf OnMakeConnection} member to return your

-own derived connection object. By default, an ordinary wxDDEConnection
+own derived connection object. By default, a wxDDEConnection

 object is returned.
 
 The advantage of deriving your own connection class is that it will
 enable you to intercept messages initiated by the server, such
 object is returned.
 
 The advantage of deriving your own connection class is that it will
 enable you to intercept messages initiated by the server, such

-as \helpref{wxDDEConnection::OnAdvise}{wxddeconnectiononadvise}. You may also want to
+as \helpref{wxDDEConnection::OnAdvise}{wxconnectiononadvise}. You may also want to

 store application-specific data in instances of the new class.
 
 store application-specific data in instances of the new class.
 

-\membersection{wxDDEClient::ValidHost}
+\membersection{wxDDEClient::ValidHost}\label{wxddeclientvalidhost}

 
 \func{bool}{ValidHost}{\param{const wxString\& }{host}}
 
 
 \func{bool}{ValidHost}{\param{const wxString\& }{host}}
 

-Returns TRUE if this is a valid host name, FALSE otherwise. This always
-returns TRUE under MS Windows.
-
+Returns \true if this is a valid host name, \false otherwise. This always
+returns \true under MS Windows.