Corrected event.h for wxKeyEvent/wxMouseEvent, and corresponding docs

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

diff --git a/docs/latex/wx/sckaddr.tex b/docs/latex/wx/sckaddr.tex
index 9c04a74b01971a023009c58fd548bd8f75ac4a1a..f356aecb76c5eb85f099d3db387ec0a2a0de08a7 100644 (file)
--- a/docs/latex/wx/sckaddr.tex
+++ b/docs/latex/wx/sckaddr.tex
@@ -3,18 +3,22 @@
 % ----------------------------------------------------------------------------
 \section{\class{wxSockAddress}}\label{wxsockaddress}
 
 % ----------------------------------------------------------------------------
 \section{\class{wxSockAddress}}\label{wxsockaddress}
 

+You are unlikely to need to use this class: only wxSocketBase uses it.
+

 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 

-{\bf Actually, you don't have to use these functions: only wxSocketBase use it.}
+\wxheading{Include files}
+
+<wx/socket.h>

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

-\helpref{wxSocketBase}{wxsocketbase}\\
-\helpref{wxIPV4address}{wxipv4address}\\
-\helpref{wxIPV6address}{wxipv6address}\\
-\helpref{wxunixaddress}{wxunixaddress}
+\helpref{wxSocketBase}{wxsocketbase}
+%\helpref{wxIPV4address}{wxipv4address}\\
+%\helpref{wxIPV6address}{wxipv6address}\\
+%\helpref{wxunixaddress}{wxunixaddress}

 
 % ----------------------------------------------------------------------------
 % Members
 
 % ----------------------------------------------------------------------------
 % Members


@@ -27,11 +31,13 @@
 %
 
 \membersection{wxSockAddress::wxSockAddress}
 %
 
 \membersection{wxSockAddress::wxSockAddress}

+

 \func{}{wxSockAddress}{\void}
 
 Default constructor.
 
 \membersection{wxSockAddress::\destruct{wxSockAddress}}
 \func{}{wxSockAddress}{\void}
 
 Default constructor.
 
 \membersection{wxSockAddress::\destruct{wxSockAddress}}

+

 \func{}{\destruct{wxSockAddress}}{\void}
 
 Default destructor.
 \func{}{\destruct{wxSockAddress}}{\void}
 
 Default destructor.


@@ -48,6 +54,7 @@ Delete all informations about the address.
 % Build
 %
 \membersection{wxSockAddress::Build}
 % Build
 %
 \membersection{wxSockAddress::Build}

+

 \func{void}{Build}{\param{struct sockaddr *\&}{ addr}, \param{size\_t\&}{ len}}
 
 Build a coded socket address.
 \func{void}{Build}{\param{struct sockaddr *\&}{ addr}, \param{size\_t\&}{ len}}
 
 Build a coded socket address.


@@ -56,6 +63,7 @@ Build a coded socket address.
 % Disassemble
 %
 \membersection{wxSockAddress::Disassemble}
 % Disassemble
 %
 \membersection{wxSockAddress::Disassemble}

+

 \func{void}{Disassemble}{\param{struct sockaddr *}{addr}, \param{size\_t}{ len}}
 
 Decode a socket address. {\bf Actually, you don't have to use this
 \func{void}{Disassemble}{\param{struct sockaddr *}{addr}, \param{size\_t}{ len}}
 
 Decode a socket address. {\bf Actually, you don't have to use this


@@ -65,91 +73,8 @@ function: only wxSocketBase use it.}
 % SockAddrLen
 %
 \membersection{wxSockAddress::SockAddrLen}
 % SockAddrLen
 %
 \membersection{wxSockAddress::SockAddrLen}

+

 \func{int}{SockAddrLen}{\void};
 
 Returns the length of the socket address.
 
 \func{int}{SockAddrLen}{\void};
 
 Returns the length of the socket address.
 

-% ----------------------------------------------------------------------------
-% CLASS: wxIPV4address
-% ----------------------------------------------------------------------------
-\section{\class{wxIPV4address}}\label{wxipv4address}
-
-\wxheading{Derived from}
-
-\helpref{wxSockAddress}{wxsockaddress}
-
-% ----------------------------------------------------------------------------
-% MEMBERS
-% ----------------------------------------------------------------------------
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-%
-% Hostname
-%
-
-\membersection{wxIPV4address::Hostname}
-\func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
-
-Use the specified {\it hostname} for the address.
-
-\wxheading{Return value}
-
-Returns FALSE if something bad happens (invalid hostname, invalid IP address). 
-
-%
-% Hostname
-%
-
-\membersection{wxIPV4address::Hostname}
-\func{wxString}{Hostname}{\void}
-
-Returns the hostname which matches the IP address.
-
-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
-\func{bool}{Service}{\param{const wxString\&}{ service}}
-
-Use the specified {\it service} string for the address.
-
-\wxheading{Return value}
-
-Returns FALSE if something bad happens (invalid service).
-
-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
-\func{bool}{Service}{\param{unsigned short}{ service}}
-
-Use the specified {\it service} for the address.
-
-\wxheading{Return value}
-
-Returns FALSE if something bad happens (invalid service).
-
-%
-% Service
-%
-
-\membersection{wxIPV4address::Service}
-\func{unsigned short}{Service}{\void}
-
-Returns the current service.
-
-%
-% LocalHost
-%
-
-\membersection{wxIPV4address::LocalHost}
-\func{bool}{LocalHost}{\void}
-
-Initialize peer host to local host.
-
-\wxheading{Return value}
-
-Returns FALSE if something bad happens.