Typo fix

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

diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex
index 04caeb84edfaa91feb97502b9f8839996d767ea8..4bb08b725695a2cc1814e3202d4e6865d0a8f929 100644 (file)
--- a/docs/latex/wx/url.tex
+++ b/docs/latex/wx/url.tex
@@ -1,18 +1,25 @@
 \section{\class{wxURL}}\label{wxurl}
 
 \section{\class{wxURL}}\label{wxurl}
 

-Parses URLs.
+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}
 
 
 Supports standard assignment operators, copy constructors,
 and comparison operators.
 
 \wxheading{Derived from}
 

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

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

+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
 \wxheading{See also}
 
 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}


@@ -25,13 +32,16 @@ and comparison operators.
 
 \membersection{wxURL::wxURL}\label{wxurlctor}
 
 
 \membersection{wxURL::wxURL}\label{wxurlctor}
 

-\func{}{wxURL}{\param{const wxString\&}{ url}}
+\func{}{wxURL}{\param{const wxString\&}{ url = wxEmptyString}}

 
 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
 
 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.
+{\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}
 
 
 \wxheading{Parameters}
 


@@ -67,7 +77,7 @@ It can be one of these errors:
 \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\_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\_NOHOST}}{A 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 occurred during negotiation.}
 \twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.}
 \twocolitem{{\bf wxURL\_CONNERR}}{Connection error.}
 \twocolitem{{\bf wxURL\_PROTOERR}}{An error occurred during negotiation.}


@@ -81,10 +91,10 @@ It can be one of these errors:
 \func{wxInputStream *}{GetInputStream}{\void}
 
 Creates a new input stream on the specified URL. You can use all but seek
 \func{wxInputStream *}{GetInputStream}{\void}
 
 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 streams. For example,
+HTTP or FTP streams don't deal with it.

 
 

-Note that this method is somewhat depreciated, all future wxWidgets applications
+Note that this method is somewhat deprecated, all future wxWidgets applications

 should really use \helpref{wxFileSystem}{wxfilesystem} instead.
 
 Example:
 should really use \helpref{wxFileSystem}{wxfilesystem} instead.
 
 Example:


@@ -108,6 +118,18 @@ Returns the initialized stream. You will have to delete it yourself.
 
 \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
 %


@@ -139,3 +161,14 @@ Sets the proxy to use for this URL.
 
 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
 
 
 \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).
+