define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index 7c1a4a3b7ee4fbd195d92a750dd37db9dabfbec1..04caeb84edfaa91feb97502b9f8839996d767ea8 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -1,8 +1,13 @@
 \section{\class{wxURL}}\label{wxurl}
 
 \section{\class{wxURL}}\label{wxurl}
 

+Parses URLs.
+
+Supports standard assignment operators, copy constructors,
+and comparison operators.
+

 \wxheading{Derived from}
 
 \wxheading{Derived from}
 

-\helpref{wxObject}{wxobject}
+\helpref{wxURI}{wxuri}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -12,23 +17,13 @@
 
 \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{\wxheading{Members}}}
 
 % ----------------------------------------------------------------------------
 % 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}}
 


@@ -42,43 +37,25 @@ contain three consecutive slashes.
 
 \docparam{url}{Url string to parse.}
 
 
 \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.
 

-%
-% 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
 %

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

 
 \constfunc{wxURLError}{GetError}{\void}
 
 
 \constfunc{wxURLError}{GetError}{\void}
 


@@ -99,14 +76,30 @@ It can be one of these errors:
 %
 % GetInputStream
 %
 %
 % GetInputStream
 %

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

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

-Creates a new input stream on the the specified URL. You can use all but seek
+Creates a new input stream on 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.
 
 functionality of wxStream. Seek isn't available on all stream. For example,
 http or ftp streams doesn'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}
 
 Returns the initialized stream. You will have to delete it yourself.
 \wxheading{Return value}
 
 Returns the initialized stream. You will have to delete it yourself.


@@ -146,13 +139,3 @@ 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.
-