Wine fixes

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index 11d860e7bb20a7703b181ab6ef6a9b0d11136df3..cd06c6688f8e76558972f227c6c7d4394269ceb9 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -1,45 +1,59 @@
 \section{\class{wxURL}}\label{wxurl}
 
 \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}
 
 \wxheading{Derived from}
 

+\helpref{wxURI}{wxuri}\\

 \helpref{wxObject}{wxobject}
 
 \helpref{wxObject}{wxobject}
 

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

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

-\helpref{wxSocketBase}{wxsocketbase},\helpref{wxProtocol}{wxprotocol}
+\helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}

 
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
 
 
 % ----------------------------------------------------------------------------
 % Members
 % ----------------------------------------------------------------------------
 

-\latexignore{\rtfignore{\membersection{Members}}}
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxURL::wxURL}\label{wxurlctor}

 
 

-\membersection{wxURL::wxURL}{wxurlconstr}
-\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.}
 
 
 \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.
 
 \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
 %
 %
 % GetProtocol
 %

-\membersection{wxURL::GetProtocol}
+\membersection{wxURL::GetProtocol}\label{wxurlgetprotocol}
+

 \func{wxProtocol\&}{GetProtocol}{\void}
 
 Returns a reference to the protocol which will be used to get the URL.
 \func{wxProtocol\&}{GetProtocol}{\void}
 
 Returns a reference to the protocol which will be used to get the URL.


@@ -47,43 +61,76 @@ Returns a reference to the protocol which will be used to get the URL.
 %
 % GetError
 %
 %
 % GetError
 %

-\membersection{wxURL::GetError}
+\membersection{wxURL::GetError}\label{wxurlgeterror}
+

 \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}
 \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\_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
 %
 \end{twocollist}%
 
 %
 % GetInputStream
 %

-\membersection{wxURL::GetInputStream}
+\membersection{wxURL::GetInputStream}\label{wxurlgetinputstream}
+

 \func{wxInputStream *}{GetInputStream}{\void}
 
 \func{wxInputStream *}{GetInputStream}{\void}
 

-Initializes the protocol and opens the input stream.
+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.

 
 

-\wxheading{Return value:}
+Note that this method is somewhat depreciated, all future wxWidgets applications
+should really use \helpref{wxFileSystem}{wxfilesystem} instead.

 
 

-It returns a read-only wxStream.
+Example:

 
 

-\wxheading{See also:}
+\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}
+
+Returns the initialized stream. You will have to delete it yourself.
+
+\wxheading{See also}

 
 \helpref{wxInputStream}{wxinputstream}
 
 
 \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
 %
 %
 % 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
 \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 +147,8 @@ the proxy like this: <hostname>:<port number>.
 %
 % SetProxy
 %
 %
 % 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.
 \func{void}{SetProxy}{\param{const wxString\&}{ url\_proxy}}
 
 Sets the proxy to use for this URL.


@@ -108,3 +156,15 @@ Sets the proxy to use for this URL.
 \wxheading{See also}
 
 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
 \wxheading{See also}
 
 \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).
+