Added wxPATH_NORM_SHORTCUT

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index 91e6ceff731cd830e4dbd10078f4608db78112a4..7c1a4a3b7ee4fbd195d92a750dd37db9dabfbec1 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -4,21 +4,39 @@
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/url.h>
+

 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
 
 \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
 % ----------------------------------------------------------------------------
 
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
 

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

 
 \membersection{wxURL::wxURL}\label{wxurlconstr}
 
 \func{}{wxURL}{\param{const wxString\&}{ url}}
 
 
 \membersection{wxURL::wxURL}\label{wxurlconstr}
 
 \func{}{wxURL}{\param{const wxString\&}{ url}}
 

-Constructs an URL object from the string.
+Constructs a URL object from the string.  The URL must be valid according
+to RFC 1738.  In particular, file URLs must be of the format
+'file://hostname/path/to/file'.  It is valid to leave out the hostname
+but slashes must remain in place-- i.e. a file URL without a hostname must
+contain three consecutive slashes.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -48,6 +66,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.
 
 
 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
 %
 %
 % GetError
 %


@@ -66,7 +93,7 @@ It can be one of these errors:
 \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\_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}%
 
 %
 \end{twocollist}%
 
 %


@@ -77,7 +104,7 @@ It can be one of these errors:
 \func{wxInputStream *}{GetInputStream}{\void}
 
 Creates a new input stream on the the specified URL. You can use all but seek
 \func{wxInputStream *}{GetInputStream}{\void}
 
 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,
+functionality of wxStream. Seek isn't available on all stream. For example,

 http or ftp streams doesn't deal with it.
 
 \wxheading{Return value}
 http or ftp streams doesn't deal with it.
 
 \wxheading{Return value}


@@ -86,8 +113,7 @@ Returns the initialized stream. You will have to delete it yourself.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-%\helpref{wxInputStream}{wxinputstream}
-wxInputStream
+\helpref{wxInputStream}{wxinputstream}

 
 %
 % SetDefaultProxy
 
 %
 % SetDefaultProxy


@@ -120,3 +146,13 @@ Sets the proxy to use for this URL.
 
 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
 
 
 \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.
+