typo

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

diff --git a/docs/latex/wx/tcpconn.tex b/docs/latex/wx/tcpconn.tex
index a0aff6b751de2c7d305bbaacf76a16754a0854ce..5f1dafc35d9840fc3ad26f2d7e5423fe82d656e0 100644 (file)
--- a/docs/latex/wx/tcpconn.tex
+++ b/docs/latex/wx/tcpconn.tex
@@ -24,6 +24,10 @@ wxConnectionBase\\
 
 <wx/sckipc.h>
 
+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
+
 \wxheading{Types}
 
 \index{wxIPCFormat}wxIPCFormat is defined as follows:
@@ -44,10 +48,17 @@ enum wxIPCFormat
   wxIPC_PENDATA =          10,
   wxIPC_RIFF =             11,
   wxIPC_WAVE =             12,
-  wxIPC_UNICODETEXT =      13,
+  wxIPC_UTF16TEXT =        13, /* CF_UNICODE */
   wxIPC_ENHMETAFILE =      14,
   wxIPC_FILENAME =         15, /* CF_HDROP */
   wxIPC_LOCALE =           16,
+  wxIPC_UTF8TEXT =         17,
+  wxIPC_UTF32TEXT =        18,
+#if SIZEOF_WCHAR_T == 2
+  wxIPC_UNICODETEXT =      wxIPC_UTF16TEXT,
+#elif SIZEOF_WCHAR_T == 4
+  wxIPC_UNICODETEXT =      wxIPC_UTF32TEXT,
+#endif
   wxIPC_PRIVATE =          20
 };
 \end{verbatim}
@@ -58,11 +69,11 @@ enum wxIPCFormat
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxTCPConnection::wxTCPConnection}
+\membersection{wxTCPConnection::wxTCPConnection}\label{wxtcpconnectionctor}
 
 \func{}{wxTCPConnection}{\void}
 
-\func{}{wxTCPConnection}{\param{char* }{buffer}, \param{int}{ size}}
+\func{}{wxTCPConnection}{\param{void* }{buffer}, \param{size\_t}{ size}}
 
 Constructs a connection object. If no user-defined connection object is
 to be derived from wxTCPConnection, then the constructor should not be
@@ -76,26 +87,38 @@ associated with the connection. Otherwise, the programmer must provide a
 a buffer and size of the buffer for the connection object to use in
 transactions.
 
-\membersection{wxTCPConnection::Advise}
+\membersection{wxTCPConnection::Advise}\label{wxtcpconnectionadvise}
+
+\func{bool}{Advise}{\param{const wxString\& }{item}, \param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format = wxIPC\_PRIVATE}}
 
-\func{bool}{Advise}{\param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}}
+\func{bool}{Advise}{\param{const wxString\& }{item}, \param{const char* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Advise}{\param{const wxString\& }{item}, \param{const wchar\_t* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Advise}{\param{const wxString\& }{item}, \param{const wxString& }{data}}
 
 Called by the server application to advise the client of a change in
 the data associated with the given item. Causes the client
-connection's \helpref{wxTCPConnection::OnAdvise}{wxtcpconnectiononadvise}
-member to be called. Returns TRUE if successful.
+connection's \helpref{wxTCPConnection::OnAdvise}{wxtcpconnectiononadvise} 
+member to be called. Returns true if successful.
+
+\membersection{wxTCPConnection::Execute}\label{wxtcpconnectionexecute}
 
-\membersection{wxTCPConnection::Execute}
+\func{bool}{Execute}{\param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format = wxIPC\_PRIVATE}}
 
-\func{bool}{Execute}{\param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}}
+\func{bool}{Execute}{\param{const char* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Execute}{\param{const wchar\_t* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Execute}{\param{const wxString& }{data}}
 
 Called by the client application to execute a command on the server. Can
 also be used to transfer arbitrary data to the server (similar
 to \helpref{wxTCPConnection::Poke}{wxtcpconnectionpoke} in that respect). Causes the
 server connection's \helpref{wxTCPConnection::OnExecute}{wxtcpconnectiononexecute} member to be
-called. Returns TRUE if successful.
+called. Returns true if successful.
 
-\membersection{wxTCPConnection::Disconnect}
+\membersection{wxTCPConnection::Disconnect}\label{wxtcpconnectiondisconnect}
 
 \func{bool}{Disconnect}{\void}
 
@@ -104,12 +127,12 @@ program; it causes the \helpref{wxTCPConnection::OnDisconnect}{wxtcpconnectionon
 to be sent to the corresponding connection object in the other
 program. The default behaviour of {\bf OnDisconnect} is to delete the
 connection, but the calling application must explicitly delete its
-side of the connection having called {\bf Disconnect}. Returns TRUE if
+side of the connection having called {\bf Disconnect}. Returns true if
 successful.
 
 \membersection{wxTCPConnection::OnAdvise}\label{wxtcpconnectiononadvise}
 
-\func{virtual bool}{OnAdvise}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size}, \param{wxIPCFormat}{ format}}
+\func{virtual bool}{OnAdvise}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format}}
 
 Message sent to the client application when the server notifies it of a
 change in the data associated with the given item.
@@ -124,7 +147,7 @@ to delete the connection object.
 
 \membersection{wxTCPConnection::OnExecute}\label{wxtcpconnectiononexecute}
 
-\func{virtual bool}{OnExecute}{\param{const wxString\& }{topic}, \param{char* }{data}, \param{int}{ size}, \param{wxIPCFormat}{ format}}
+\func{virtual bool}{OnExecute}{\param{const wxString\& }{topic}, \param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat}{ format}}
 
 Message sent to the server application when the client notifies it to
 execute the given data. Note that there is no item associated with
@@ -132,14 +155,14 @@ this message.
 
 \membersection{wxTCPConnection::OnPoke}\label{wxtcpconnectiononpoke}
 
-\func{virtual bool}{OnPoke}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size}, \param{wxIPCFormat}{ format}}
+\func{virtual bool}{OnPoke}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format}}
 
 Message sent to the server application when the client notifies it to
 accept the given data.
 
 \membersection{wxTCPConnection::OnRequest}\label{wxtcpconnectiononrequest}
 
-\func{virtual char*}{OnRequest}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{int *}{size}, \param{wxIPCFormat}{ format}}
+\func{virtual const void*}{OnRequest}{\param{const wxString\& }{topic}, \param{const wxString\& }{item}, \param{size\_t *}{size}, \param{wxIPCFormat }{format}}
 
 Message sent to the server application when the client
 calls \helpref{wxTCPConnection::Request}{wxtcpconnectionrequest}. The server
@@ -152,7 +175,7 @@ or NULL to indicate no data.
 
 Message sent to the server application by the client, when the client
 wishes to start an `advise loop' for the given topic and item. The
-server can refuse to participate by returning FALSE.
+server can refuse to participate by returning false.
 
 \membersection{wxTCPConnection::OnStopAdvise}\label{wxtcpconnectiononstopadvise}
 
@@ -160,21 +183,27 @@ server can refuse to participate by returning FALSE.
 
 Message sent to the server application by the client, when the client
 wishes to stop an `advise loop' for the given topic and item. The
-server can refuse to stop the advise loop by returning FALSE, although
+server can refuse to stop the advise loop by returning false, although
 this doesn't have much meaning in practice.
 
 \membersection{wxTCPConnection::Poke}\label{wxtcpconnectionpoke}
 
-\func{bool}{Poke}{\param{const wxString\& }{item}, \param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}}
+\func{bool}{Poke}{\param{const wxString\& }{item}, \param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format = wxIPC\_PRIVATE}}
+
+\func{bool}{Poke}{\param{const wxString\& }{item}, \param{const char* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Poke}{\param{const wxString\& }{item}, \param{const wchar\_t* }{data}, \param{size\_t }{size = (size\_t)-1}}
+
+\func{bool}{Poke}{\param{const wxString\& }{item}, \param{const wxString& }{data}}
 
 Called by the client application to poke data into the server. Can be
 used to transfer arbitrary data to the server. Causes the server
 connection's \helpref{wxTCPConnection::OnPoke}{wxtcpconnectiononpoke} member
-to be called. Returns TRUE if successful.
+to be called. Returns true if successful.
 
 \membersection{wxTCPConnection::Request}\label{wxtcpconnectionrequest}
 
-\func{char*}{Request}{\param{const wxString\& }{item}, \param{int *}{size}, \param{wxIPCFormat}{ format = wxIPC\_TEXT}}
+\func{const void*}{Request}{\param{const wxString\& }{item}, \param{size\_t *}{size}, \param{wxIPCFormat }{format = wxIPC\_TEXT}}
 
 Called by the client application to request data from the server. Causes
 the server connection's \helpref{wxTCPConnection::OnRequest}{wxtcpconnectiononrequest} member to be called. Returns a
@@ -187,7 +216,7 @@ successful, NULL otherwise.
 
 Called by the client application to ask if an advise loop can be started
 with the server. Causes the server connection's \helpref{wxTCPConnection::OnStartAdvise}{wxtcpconnectiononstartadvise}\rtfsp
-member to be called. Returns TRUE if the server okays it, FALSE
+member to be called. Returns true if the server okays it, false
 otherwise.
 
 \membersection{wxTCPConnection::StopAdvise}\label{wxtcpconnectionstopadvise}
@@ -196,5 +225,5 @@ otherwise.
 
 Called by the client application to ask if an advise loop can be
 stopped. Causes the server connection's \helpref{wxTCPConnection::OnStopAdvise}{wxtcpconnectiononstopadvise} member
-to be called. Returns TRUE if the server okays it, FALSE otherwise.
+to be called. Returns true if the server okays it, false otherwise.