Mark GetMinSize() as virtual and explain why.

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index 66c49c7aad4efdea29a2fa7a90725ace6583bcbb..cd06c6688f8e76558972f227c6c7d4394269ceb9 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -1,9 +1,21 @@
 \section{\class{wxURL}}\label{wxurl}
 
+wxURL is a specialization of \helpref{wxURI}{wxuri} for parsing URLs.
+Please look at \helpref{wxURI}{wxuri} documentation for more info about the functions
+you can use to retrieve the various parts of the URL (scheme, server, port, etc).
+
+Supports standard assignment operators, copy constructors,
+and comparison operators.
+
 \wxheading{Derived from}
 
+\helpref{wxURI}{wxuri}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/url.h>
+
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
@@ -12,37 +24,35 @@
 % Members
 % ----------------------------------------------------------------------------
 
-\latexignore{\rtfignore{\membersection{Members}}}
+\latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxURL::wxURL}\label{wxurlconstr}
+\membersection{wxURL::wxURL}\label{wxurlctor}
 
-\func{}{wxURL}{\param{const wxString\&}{ url}}
+\func{}{wxURL}{\param{const wxString\&}{ url = wxEmptyString}}
 
-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
+{\tt file://hostname/path/to/file} otherwise \helpref{GetError}{wxurlgeterror}
+will return a value different from {\tt wxURL\_NOERR}.
+
+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 
+(e.g. {\tt file:///somepath/myfile}).
 
 \wxheading{Parameters}
 
 \docparam{url}{Url string to parse.}
 
-\membersection{wxURL::\destruct{wxURL}}
+\membersection{wxURL::\destruct{wxURL}}\label{wxurldtor}
 
 \func{}{\destruct{wxURL}}{\void}
 
 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.
-
 %
 % GetProtocol
 %
-\membersection{wxURL::GetProtocol}
+\membersection{wxURL::GetProtocol}\label{wxurlgetprotocol}
 
 \func{wxProtocol\&}{GetProtocol}{\void}
 
@@ -51,7 +61,7 @@ Returns a reference to the protocol which will be used to get the URL.
 %
 % GetError
 %
-\membersection{wxURL::GetError}
+\membersection{wxURL::GetError}\label{wxurlgeterror}
 
 \constfunc{wxURLError}{GetError}{\void}
 
@@ -66,19 +76,35 @@ 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\_PROTOERR}}{An error occured during negotiation.}
+\twocolitem{{\bf wxURL\_PROTOERR}}{An error occurred during negotiation.}
 \end{twocollist}%
 
 %
 % GetInputStream
 %
-\membersection{wxURL::GetInputStream}
+\membersection{wxURL::GetInputStream}\label{wxurlgetinputstream}
 
 \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,
-http or ftp streams doesn't deal with it.
+Creates a new input stream on the specified URL. You can use all but seek
+functionality of wxStream. Seek isn't available on all streams. For example,
+HTTP or FTP streams don't deal with it.
+
+Note that this method is somewhat depreciated, all future wxWidgets applications
+should really use \helpref{wxFileSystem}{wxfilesystem} instead.
+
+Example:
+
+\begin{verbatim}
+  wxURL url("http://a.host/a.dir/a.file");
+  if (url.GetError() == wxURL_NOERR)
+  {
+      wxInputStream *in_stream;
+
+      in_stream = url.GetInputStream();
+      // Then, you can use all IO calls of in_stream (See wxStream)
+  }
+\end{verbatim}
 
 \wxheading{Return value}
 
@@ -88,6 +114,18 @@ Returns the initialized stream. You will have to delete it yourself.
 
 \helpref{wxInputStream}{wxinputstream}
 
+
+%
+% IsOk
+%
+\membersection{wxURL::IsOk}\label{wxurlgetisok}
+
+\constfunc{bool}{IsOk}{\void}
+
+Returns \true if this object is correctly initialized, i.e. if 
+\helpref{GetError}{wxurlgeterror} returns {\tt wxURL\_NOERR}.
+
+
 %
 % SetDefaultProxy
 %
@@ -119,3 +157,14 @@ Sets the proxy to use for this URL.
 
 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
 
+
+%
+% SetURL
+%
+\membersection{wxURL::SetURL}\label{wxurlseturl}
+
+\func{wxURLError}{SetURL}{\param{const wxString\&}{ url}}
+
+Initializes this object with the given URL and returns {\tt wxURL\_NOERR}
+if it's valid (see \helpref{GetError}{wxurlgeterror} for more info).
+