Added wxHtmlPrintout::AddFilter so the same filters used for

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index 11d860e7bb20a7703b181ab6ef6a9b0d11136df3..7c1a4a3b7ee4fbd195d92a750dd37db9dabfbec1 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -4,26 +4,46 @@
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/url.h>
+
 \wxheading{See also}
 
-\helpref{wxSocketBase}{wxsocketbase},\helpref{wxProtocol}{wxprotocol}
+\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}
 
-\membersection{wxURL::wxURL}{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}
 
 \docparam{url}{Url string to parse.}
 
 \membersection{wxURL::\destruct{wxURL}}
+
 \func{}{\destruct{wxURL}}{\void}
 
 Destroys the URL object.
@@ -32,6 +52,7 @@ Destroys the URL object.
 % GetProtocolName
 %
 \membersection{wxURL::GetProtocolName}
+
 \constfunc{wxString}{GetProtocolName}{\void}
 
 Returns the name of the protocol which will be used to get the URL.
@@ -40,50 +61,65 @@ Returns the name of the protocol which will be used to get the URL.
 % GetProtocol
 %
 \membersection{wxURL::GetProtocol}
+
 \func{wxProtocol\&}{GetProtocol}{\void}
 
 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
 %
 \membersection{wxURL::GetError}
+
 \constfunc{wxURLError}{GetError}{\void}
 
 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}%
 
 %
 % GetInputStream
 %
 \membersection{wxURL::GetInputStream}
+
 \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
+functionality of wxStream. Seek isn't available on all stream. For example,
+http or ftp streams doesn't deal with it.
 
-\wxheading{Return value:}
+\wxheading{Return value}
 
-It returns a read-only wxStream.
+Returns the initialized stream. You will have to delete it yourself.
 
-\wxheading{See also:}
+\wxheading{See also}
 
 \helpref{wxInputStream}{wxinputstream}
 
 %
 % SetDefaultProxy
 %
-\membersection{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
+\membersection{wxURL::SetDefaultProxy}\label{wxurlsetdefaultproxy}
+
 \func{static void}{SetDefaultProxy}{\param{const wxString\&}{ url\_proxy}}
 
 Sets the default proxy server to use to get the URL. The string specifies
@@ -100,7 +136,8 @@ the proxy like this: <hostname>:<port number>.
 %
 % SetProxy
 %
-\membersection{wxURL::SetProxy}{wxurlsetproxy}
+\membersection{wxURL::SetProxy}\label{wxurlsetproxy}
+
 \func{void}{SetProxy}{\param{const wxString\&}{ url\_proxy}}
 
 Sets the proxy to use for this URL.
@@ -108,3 +145,14 @@ Sets the proxy to use for this URL.
 \wxheading{See also}
 
 \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.
+