implemented wxNotificationMessage for wxMSW using wxTaskBarIcon and fallback to gener...

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

diff --git a/docs/latex/wx/http.tex b/docs/latex/wx/http.tex
index 7b878ead9982ad82fd60a1364a3f1795eaf5cc32..3a4a9a1ffe2f74b667c46bee3b374f09900ef52d 100644 (file)
--- a/docs/latex/wx/http.tex
+++ b/docs/latex/wx/http.tex
@@ -2,12 +2,19 @@
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxProtocol}{wxprotocol}
+\helpref{wxProtocol}{wxprotocol}\\
+\helpref{wxSocketClient}{wxsocketclient}\\
+\helpref{wxSocketBase}{wxsocketbase}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 <wx/protocol/http.h>
 
 
 \wxheading{Include files}
 
 <wx/protocol/http.h>
 

+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxURL}{wxurl}


@@ -16,31 +23,38 @@
 % Members
 % ----------------------------------------------------------------------------
 
 % Members
 % ----------------------------------------------------------------------------
 

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

 % ----------------------------------------------------------------------------
 % ----------------------------------------------------------------------------

+\membersection{wxHTTP::GetResponse}\label{wxhttpgetresponse}
+
+\constfunc{int}{GetResponse}{\void}
+
+Returns the HTTP response code returned by the server. Please refer to
+\urlref{RFC 2616}{http://www.faqs.org/rfcs/rfc2616.html} for the list of responses.
+
+

 \membersection{wxHTTP::GetInputStream}\label{wxhttpgetinputstream}
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 
 \membersection{wxHTTP::GetInputStream}\label{wxhttpgetinputstream}
 
 \func{wxInputStream *}{GetInputStream}{\param{const wxString\&}{ path}}
 

-Creates a new input stream on the the specified path. You can use all except the seek
-functionality of wxStream. Seek isn't available on all streams. For example,
-http or ftp streams doesn't deal with it. Other functions like Tell and SeekI
-for this sort of stream.
-You will be notified when the EOF is reached by an error.
-
-\wxheading{Note}
+Creates a new input stream on the specified path. Notice that this stream is
+unseekable, i.e. SeekI() and TellI() methods shouldn't be used.

 
 

-You can know the size of the file you are getting using \helpref{wxStreamBase::GetSize()}{wxstreambasegetsize}.
-But there is a limitation: as HTTP servers aren't obliged to pass the size ofi
-the file, in some case, you will be returned 0xfffffff by GetSize(). In these
-cases, you should use the value returned by \helpref{wxInputStream::LastRead()}{wxinputstreamlastread}:
-this value will be 0 when the stream is finished.
+Note that you can still know the size of the file you are getting using 
+\helpref{wxStreamBase::GetSize()}{wxstreambasegetsize}. However there is a
+limitation: in HTTP protocol, the size is not always specified so sometimes
+\texttt{(size\_t)-1} can returned ot indicate that the size is unknown. In such
+case, you may want to use \helpref{wxInputStream::LastRead()}{wxinputstreamlastread} 
+method in a loop to get the total size.

 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns the initialized stream. You will have to delete it yourself once you
-don't use it anymore. The destructor closes the network connection.
-The next time you will try to get a file the network connection will have
-to be reestablished: but you don't have to take care of this wxHTTP reestablishes it automatically.
+Returns the initialized stream. You must delete it yourself once you
+don't use it anymore and this must be done before the wxHTTP object itself is
+destroyed. The destructor closes the network connection. The next time you will
+try to get a file the network connection will have to be reestablished, but you
+don't have to take care of this since wxHTTP reestablishes it automatically.

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


@@ -48,7 +62,7 @@ to be reestablished: but you don't have to take care of this wxHTTP reestablishe
 
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 

-\membersection{wxHTTP::SetHeader}
+\membersection{wxHTTP::SetHeader}\label{wxhttpsetheader}

 
 \func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h\_data}}
 
 
 \func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h\_data}}
 


@@ -56,7 +70,7 @@ It sets data of a field to be sent during the next request to the HTTP server. T
 name is specified by {\it header} and the content by {\it h\_data}.
 This is a low level function and it assumes that you know what you are doing.
 
 name is specified by {\it header} and the content by {\it h\_data}.
 This is a low level function and it assumes that you know what you are doing.
 

-\membersection{wxHTTP::GetHeader}
+\membersection{wxHTTP::GetHeader}\label{wxhttpgetheader}

 
 \func{wxString}{GetHeader}{\param{const wxString\&}{ header}}
 
 
 \func{wxString}{GetHeader}{\param{const wxString\&}{ header}}
 


@@ -65,6 +79,6 @@ If the field doesn't exist, it will return an empty string and not a NULL string
 
 \wxheading{Note}
 
 
 \wxheading{Note}
 

-The header is not case-sensitive: I mean that "CONTENT-TYPE" and "content-type" 
+The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type" 

 represent the same header.
 
 represent the same header.