EnableTool() should be called after Realize()

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

diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex
index 9d27c9e945c69bb5c7092b9a8f814b35054acdc9..68490521f6fb50eef8b926f52c26e59428a82a52 100644 (file)
--- a/docs/latex/wx/socket.tex
+++ b/docs/latex/wx/socket.tex
@@ -138,8 +138,8 @@ recv() or send() as needed so as to transfer all the data. Note that
 "blocking" here refers to when the function returns, not to whether
 the GUI blocks during this time.
 
-The {\bf wxSOCKET\_BLOCK} controls whether the GUI blocks during IO
-operations. If this flag is not used, then the application must take
+The {\bf wxSOCKET\_BLOCK} flag controls whether the GUI blocks during
+IO operations. If this flag is not used, then the application must take
 extra care to avoid unwanted reentrance. 
 
 So:
@@ -153,7 +153,7 @@ read or write ANY data.
 the data.
 
 {\bf wxSOCKET\_BLOCK} has nothing to do with the previous flags and
-it control whether the GUI blocks.
+it controls whether the GUI blocks.
 
 %
 % SetNotify
@@ -188,7 +188,7 @@ For more information on socket events see \helpref{wxSocket events}{wxsocketbase
 %
 % SetTimeout
 %
-\membersection{wxSocketBase::SetTimeout}{wxsocketbasesettimeout}
+\membersection{wxSocketBase::SetTimeout}\label{wxsocketbasesettimeout}
 
 \func{void}{SetTimeout}{\param{int }{seconds}}
 
@@ -411,9 +411,9 @@ Returns a reference to the current object.
 
 \wxheading{Remark/Warning}
 
-wxSocketBase::WriteMsg() will behave as if the wxSOCKET_WAITALL flag was always set
-and it will always ignore the wxSOCKET_NOWAIT flag. The exact behaviour of WriteMsg
-depends on the wxSOCKET_BLOCK flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
+wxSocketBase::WriteMsg() will behave as if the wxSOCKET\_WAITALL flag was always set
+and it will always ignore the wxSOCKET\_NOWAIT flag. The exact behaviour of WriteMsg
+depends on the wxSOCKET\_BLOCK flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
 
 \wxheading{See also}
 
@@ -450,9 +450,9 @@ Returns a reference to the current object.
 
 \wxheading{Remark/Warning}
 
-wxSocketBase::ReadMsg() will behave as if the wxSOCKET_WAITALL flag was always set
-and it will always ignore the wxSOCKET_NOWAIT flag. The exact behaviour of ReadMsg
-depends on the wxSOCKET_SPEED flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
+wxSocketBase::ReadMsg() will behave as if the wxSOCKET\_WAITALL flag was always set
+and it will always ignore the wxSOCKET\_NOWAIT flag. The exact behaviour of ReadMsg
+depends on the wxSOCKET\_BLOCK flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
 
 \wxheading{See also}
 
@@ -501,7 +501,7 @@ Returns a reference to the current object.
 
 This function simply deletes all bytes in the incoming queue. This function
 doesn't wait. That is, it will behave as if the wxSOCKET\_NOWAIT flag was set. The
-wxSOCKET\_SPEED and wxSOCKET\_WAITALL flags have no effect on this function.
+wxSOCKET\_BLOCK and wxSOCKET\_WAITALL flags have no effect on this function.
 
 Use LastCount to see the number of bytes discarded.
 
@@ -639,7 +639,7 @@ Calls to SaveState / RestoreState can be nested.
 \func{void}{SaveState}{\void}
 
 This function saves the current state of the socket object in a stack:
-actually it saves all flags (those set with SetFlags, SetNotify, Notfy)
+actually it saves all flags (those set with SetFlags, SetNotify, Notify)
 and the state of the asynchronous callbacks (Callback, CallbackData).
 
 Calls to SaveState / RestoreState can be nested.
@@ -653,7 +653,7 @@ Calls to SaveState / RestoreState can be nested.
 %
 \membersection{wxSocketBase::GetLocal}{wxsocketbasegetlocal}
 
-\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr_man}}
+\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr\_man}}
 
 This function returns the local address field of the socket. The local
 address field contains the complete local address of the socket (local
@@ -668,7 +668,7 @@ It returns TRUE if no errors happened, FALSE otherwise.
 %
 \membersection{wxSocketBase::GetPeer}{wxsocketbasegetlocal}
 
-\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr_man}}
+\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr\_man}}
 
 This function returns the peer address field of the socket. The peer 
 address field contains the complete peer host address of the socket
@@ -721,7 +721,7 @@ void SocketCallback(wxSocketBase& sock,wxSocketNotify evt,char *cdata);
 
 The first parameter is a reference to the socket object in which the event
 occured. The second parameter tells you which event occured. (See \helpref{wxSocket events}{wxsocketbase}).
-The third parameter is the user data you specified using \helpref{CallbackData}{wxsocketcallbackdata}.
+The third parameter is the user data you specified using \helpref{CallbackData}{wxsocketbasecallbackdata}.
 
 \wxheading{Return value}
 
@@ -879,10 +879,6 @@ functions that take a wxSocketEvent argument.
 \twocolitem{{\bf EVT\_SOCKET(id, func)}}{Process a socket event, supplying the member function.}
 \end{twocollist}%
 
-[TODO:]
-A brief note on how to use events.
-The wxSOCKET_INPUT event is generated when the
-
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, 
@@ -948,7 +944,7 @@ Destroys a wxSocketServer object (it doesn't close the accepted connections).
 %
 % Accept
 %
-\membersection{wxSocketServer::Accept}
+\membersection{wxSocketServer::Accept}\label{wxsocketserveraccept}
 
 \func{wxSocketBase *}{Accept}{\param{bool}{ wait = TRUE}}
 
@@ -973,7 +969,7 @@ connections.
 
 \wxheading{See also}
 
-\helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept}, 
+\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, 
 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, 
 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}, 
 \helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
@@ -998,10 +994,10 @@ Returns TRUE on success, or FALSE if an error occured or if the
 {\it wait} parameter was FALSE and there were no pending
 connections.
 
-\helpref{wxSocketServer::WaitForAccept}{wxsocketbasewaitforaccept}, 
+\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, 
 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, 
 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}, 
-\helpref{wxSocketServer::Accept}{wxsocketserveraccept}
+\helpref{wxSocketServer::Accept}{wxsocketserveraccept} for a detailed explanation
 
 %
 % WaitForAccept