X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/15d83f726c215b06f2fdd15ece40d66d2f16a01d..65afac3fbc6115b899045d767af823fc3abd7322:/docs/latex/wx/url.tex diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex index 187ab2bc42..04caeb84ed 100644 --- a/docs/latex/wx/url.tex +++ b/docs/latex/wx/url.tex @@ -1,8 +1,13 @@ \section{\class{wxURL}}\label{wxurl} +Parses URLs. + +Supports standard assignment operators, copy constructors, +and comparison operators. + \wxheading{Derived from} -\helpref{wxObject}{wxobject} +\helpref{wxURI}{wxuri} \wxheading{Include files} @@ -12,16 +17,6 @@ \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 % ---------------------------------------------------------------------------- @@ -48,15 +43,6 @@ contain three consecutive slashes. Destroys the URL object. -% -% GetProtocolName -% -\membersection{wxURL::GetProtocolName}\label{wxurlgetprotocolname} - -\constfunc{wxString}{GetProtocolName}{\void} - -Returns the name of the protocol which will be used to get the URL. - % % GetProtocol % @@ -66,15 +52,6 @@ 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. -% -% GetPath -% -\membersection{wxURL::GetPath}\label{wxurlgetpath} - -\func{wxString}{GetPath}{\void} - -Returns the path of the file to fetch. This path was encoded in the URL. - % % GetError % @@ -103,10 +80,26 @@ 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 +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. +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. @@ -146,13 +139,3 @@ Sets the proxy to use for this URL. \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy} -% -% SetProxy -% -\membersection{wxURL::ConvertToValidURI}\label{wxurlconverttovaliduri} - -\func{static wxString}{ConvertToValidURI}{\param{const wxString\&}{ uri}} - -It converts a non-standardized URI to a valid network URI. It encodes non -standard characters. -