added and documented wxApp::OnAssert

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index dcd6399e90f0e91e0f917acae4d646ac212e4d71..c648fb918a07fe6655afd94dcb20d862be7f7184 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -4,15 +4,29 @@
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/url.h>
+
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
 
+\wxheading{Example}
+
+\begin{verbatim}
+  wxURL url("http://a.host/a.dir/a.file");
+  wxInputStream *in_stream;
+
+  in_stream = url.GetInputStream();
+  // Then, you can use all IO calls of in_stream (See wxStream)
+\end{verbatim}
+
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
 
-\latexignore{\rtfignore{\membersection{Members}}}
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxURL::wxURL}\label{wxurlconstr}
 
@@ -48,6 +62,15 @@ Returns the name of the protocol which will be used to get the URL.
 
 Returns a reference to the protocol which will be used to get the URL.
 
+%
+% GetPath
+%
+\membersection{wxURL::GetPath}
+
+\func{wxString}{GetPath}{\void}
+
+Returns the path of the file to fetch. This path was encoded in the URL.
+
 %
 % GetError
 %
@@ -59,14 +82,14 @@ Returns the last error. This error refers to the URL parsing or to the protocol.
 It can be one of these errors:
 
 \twocolwidtha{7cm}
-\begin{twocollist}\itemsep=0pt
+\begin{twocollist}\itemsep=0pt%
 \twocolitem{{\bf wxURL\_NOERR}}{No error.}
 \twocolitem{{\bf wxURL\_SNTXERR}}{Syntax error in the URL string.}
 \twocolitem{{\bf wxURL\_NOPROTO}}{Found no protocol which can get this URL.}
 \twocolitem{{\bf wxURL\_NOHOST}}{An host name is required for this protocol.}
 \twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.}
 \twocolitem{{\bf wxURL\_CONNERR}}{Connection error.}
-\twocolitem{{\bf wxURL\_PROTOERR}}{An error occured during negotiation.}
+\twocolitem{{\bf wxURL\_PROTOERR}}{An error occurred during negotiation.}
 \end{twocollist}%
 
 %
@@ -76,11 +99,13 @@ It can be one of these errors:
 
 \func{wxInputStream *}{GetInputStream}{\void}
 
-Initializes the protocol and opens the input stream.
+Creates a new input stream on the the specified URL. You can use all but seek
+functionnality of wxStream. Seek isn't available on all stream. For example,
+http or ftp streams doesn't deal with it.
 
 \wxheading{Return value}
 
-It returns a read-only wxStream.
+Returns the initialized stream. You will have to delete it yourself.
 
 \wxheading{See also}
 
@@ -117,3 +142,13 @@ Sets the proxy to use for this URL.
 
 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
 
+%
+% SetProxy
+%
+\membersection{wxURL::ConvertToValidURI}
+
+\func{static wxString}{ConvertToValidURI}{\param{const wxString\&}{ uri}}
+
+It converts a non-standardized URI to a valid network URI. It encodes non
+standard characters.
+