]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/tcpconn.tex
Ensure AutoComp items with no type will set the item's image index to -1.
[wxWidgets.git] / docs / latex / wx / tcpconn.tex
index a530e47064c230c354de67105f12bd25289c7268..5f1dafc35d9840fc3ad26f2d7e5423fe82d656e0 100644 (file)
@@ -24,6 +24,10 @@ wxConnectionBase\\
 
 <wx/sckipc.h>
 
 
 <wx/sckipc.h>
 
+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
+
 \wxheading{Types}
 
 \index{wxIPCFormat}wxIPCFormat is defined as follows:
 \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_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_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}
   wxIPC_PRIVATE =          20
 };
 \end{verbatim}
@@ -62,7 +73,7 @@ enum wxIPCFormat
 
 \func{}{wxTCPConnection}{\void}
 
 
 \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
 
 Constructs a connection object. If no user-defined connection object is
 to be derived from wxTCPConnection, then the constructor should not be
@@ -78,7 +89,13 @@ transactions.
 
 \membersection{wxTCPConnection::Advise}\label{wxtcpconnectionadvise}
 
 
 \membersection{wxTCPConnection::Advise}\label{wxtcpconnectionadvise}
 
-\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 void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format = wxIPC\_PRIVATE}}
+
+\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
 
 Called by the server application to advise the client of a change in
 the data associated with the given item. Causes the client
@@ -87,7 +104,13 @@ member to be called. Returns true if successful.
 
 \membersection{wxTCPConnection::Execute}\label{wxtcpconnectionexecute}
 
 
 \membersection{wxTCPConnection::Execute}\label{wxtcpconnectionexecute}
 
-\func{bool}{Execute}{\param{char* }{data}, \param{int}{ size = -1}, \param{wxIPCFormat}{ format = wxCF\_TEXT}}
+\func{bool}{Execute}{\param{const void* }{data}, \param{size\_t }{size}, \param{wxIPCFormat }{format = wxIPC\_PRIVATE}}
+
+\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
 
 Called by the client application to execute a command on the server. Can
 also be used to transfer arbitrary data to the server (similar
@@ -109,7 +132,7 @@ successful.
 
 \membersection{wxTCPConnection::OnAdvise}\label{wxtcpconnectiononadvise}
 
 
 \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.
 
 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}
 
 
 \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
 
 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}
 
 
 \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}
 
 
 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
 
 Message sent to the server application when the client
 calls \helpref{wxTCPConnection::Request}{wxtcpconnectionrequest}. The server
@@ -165,7 +188,13 @@ this doesn't have much meaning in practice.
 
 \membersection{wxTCPConnection::Poke}\label{wxtcpconnectionpoke}
 
 
 \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
 
 Called by the client application to poke data into the server. Can be
 used to transfer arbitrary data to the server. Causes the server
@@ -174,7 +203,7 @@ to be called. Returns true if successful.
 
 \membersection{wxTCPConnection::Request}\label{wxtcpconnectionrequest}
 
 
 \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
 
 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