wxR?_USE_CHECKBOX style for wxPalmOS.

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

diff --git a/docs/latex/wx/uri.tex b/docs/latex/wx/uri.tex
index cfe193374ba407bc4aa16d3f1bb9ad98a90d2584..6b06deb7f0b86959e33e7cff973cb2b75ac4bed7 100644 (file)
--- a/docs/latex/wx/uri.tex
+++ b/docs/latex/wx/uri.tex
@@ -22,6 +22,9 @@ In short, a URL \em{is} a URI.  In other
 words, URL is a subset of a URI - all 
 acceptable URLs are also acceptable URIs.
 
+wxURI automatically escapes invalid characters in a string,
+so there is no chance of wxURI "failing" on construction/creation.
+
 wxURI supports copy construction and standard assignment
 operators.  wxURI can also be inherited from to provide
 furthur functionality.
@@ -36,10 +39,10 @@ furthur functionality.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{Obtaining individual components}
+\membersection{Obtaining individual components}\label{obtainingwxuricomponents}
 
 To obtain individual components you can use 
-one of the following methods:
+one of the following methods
 
 \helpref{GetScheme}{wxurigetscheme}\\
 \helpref{GetUser}{wxurigetuser}\\
@@ -50,8 +53,12 @@ one of the following methods:
 \helpref{GetFragment}{wxurigetfragment}
 
 However, you should check HasXXX before
-calling a get method:\\
- 
+calling a get method, which determines whether or not the component referred
+to by the method is defined according to RFC 2396.
+
+Consider an undefined component equivilent to a 
+NULL C string.\\
+\\ 
 \helpref{HasScheme}{wxurihasscheme}\\
 \helpref{HasUser}{wxurihasuser}\\
 \helpref{HasServer}{wxurihasserver}\\
@@ -107,15 +114,18 @@ Builds the URI from its individual components, adds proper seperators, and
 returns escape sequences to normal characters.
 
 Note that it is preferred to call this over Unescape(BuildURI()) since
-BuildUnescapedURI performs some optimizations over the plain method.
+\helpref{BuildUnescapedURI}{wxuribuildunescapeduri} performs some optimizations over the plain method.
 
 
 \membersection{wxURI::Create}\label{wxuricreate}
 
-\func{void}{Create}{\param{const wxChar* }{uri}}
+\func{const wxChar*}{Create}{\param{const wxChar* }{uri}}
 
 Creates this URI from the string \arg{uri}.
 
+Returns the position at which parsing stopped (there 
+is no such thing as an "invalid" wxURI).
+
 \docparam{uri}{string to initialize from}
 
 
@@ -320,9 +330,9 @@ to 2396}
 Translates all escape sequences (% hex hex) of \arg{uri} into
 normal characters and returns the result.
 
-This is the preferred over wxURL::ConvertFromURI.
+This is the preferred over deprecated wxURL::ConvertFromURI.
 
-If you want to unescape an entire wxURI, use BuildUnescapedURI instead,
+If you want to unescape an entire wxURI, use \helpref{BuildUnescapedURI}{wxuribuildunescapeduri} instead,
 as it performs some optimizations over this method.
 
 \docparam{uri}{string with escaped characters to convert}