projects
/
wxWidgets.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
compilation fix after TRUE/FALSE change
[wxWidgets.git]
/
docs
/
latex
/
wx
/
url.tex
diff --git
a/docs/latex/wx/url.tex
b/docs/latex/wx/url.tex
index 91e6ceff731cd830e4dbd10078f4608db78112a4..c648fb918a07fe6655afd94dcb20d862be7f7184 100644
(file)
--- a/
docs/latex/wx/url.tex
+++ b/
docs/latex/wx/url.tex
@@
-4,15
+4,29
@@
\helpref{wxObject}{wxobject}
\helpref{wxObject}{wxobject}
+\wxheading{Include files}
+
+<wx/url.h>
+
\wxheading{See also}
\helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
\wxheading{See also}
\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
% ----------------------------------------------------------------------------
% ----------------------------------------------------------------------------
% Members
% ----------------------------------------------------------------------------
-\latexignore{\rtfignore{\
membersection
{Members}}}
+\latexignore{\rtfignore{\
wxheading
{Members}}}
\membersection{wxURL::wxURL}\label{wxurlconstr}
\membersection{wxURL::wxURL}\label{wxurlconstr}
@@
-48,6
+62,15
@@
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.
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
%
@@
-66,7
+89,7
@@
It can be one of these errors:
\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\_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 occur
r
ed during negotiation.}
\end{twocollist}%
%
\end{twocollist}%
%
@@
-86,8
+109,7
@@
Returns the initialized stream. You will have to delete it yourself.
\wxheading{See also}
\wxheading{See also}
-%\helpref{wxInputStream}{wxinputstream}
-wxInputStream
+\helpref{wxInputStream}{wxinputstream}
%
% SetDefaultProxy
%
% SetDefaultProxy
@@
-120,3
+142,13
@@
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.
+