docs/latex/wx/url.tex

   1 \section{\class{wxURL}}\label{wxurl}
   2
   3 \wxheading{Derived from}
   4
   5 \helpref{wxObject}{wxobject}
   6
   7 \wxheading{Include files}
   8
   9 <wx/url.h>
  10
  11 \wxheading{See also}
  12
  13 \helpref{wxSocketBase}{wxsocketbase}, \helpref{wxProtocol}{wxprotocol}
  14
  15 \wxheading{Example}
  16
  17 \begin{verbatim}
  18   wxURL url("http://a.host/a.dir/a.file");
  19   wxInputStream *in\_stream;
  20
  21   in\_stream = url.GetInputStream();
  22   /* Then, you can use all IO calls of in\_stream (See wxStream) */
  23 \end{verbatim}
  24
  25 % ----------------------------------------------------------------------------
  26 % Members
  27 % ----------------------------------------------------------------------------
  28 \latexignore{\rtfignore{\membersection{Members}}}
  29
  30 \membersection{wxURL::wxURL}\label{wxurlconstr}
  31
  32 \func{}{wxURL}{\param{const wxString\&}{ url}}
  33
  34 Constructs an URL object from the string.
  35
  36 \wxheading{Parameters}
  37
  38 \docparam{url}{Url string to parse.}
  39
  40 \membersection{wxURL::\destruct{wxURL}}
  41
  42 \func{}{\destruct{wxURL}}{\void}
  43
  44 Destroys the URL object.
  45
  46 %
  47 % GetProtocolName
  48 %
  49 \membersection{wxURL::GetProtocolName}
  50
  51 \constfunc{wxString}{GetProtocolName}{\void}
  52
  53 Returns the name of the protocol which will be used to get the URL.
  54
  55 %
  56 % GetProtocol
  57 %
  58 \membersection{wxURL::GetProtocol}
  59
  60 \func{wxProtocol\&}{GetProtocol}{\void}
  61
  62 Returns a reference to the protocol which will be used to get the URL.
  63
  64 %
  65 % GetError
  66 %
  67 \membersection{wxURL::GetError}
  68
  69 \constfunc{wxURLError}{GetError}{\void}
  70
  71 Returns the last error. This error refers to the URL parsing or to the protocol.
  72 It can be one of these errors:
  73
  74 \twocolwidtha{7cm}
  75 \begin{twocollist}\itemsep=0pt%
  76 \twocolitem{{\bf wxURL\_NOERR}}{No error.}
  77 \twocolitem{{\bf wxURL\_SNTXERR}}{Syntax error in the URL string.}
  78 \twocolitem{{\bf wxURL\_NOPROTO}}{Found no protocol which can get this URL.}
  79 \twocolitem{{\bf wxURL\_NOHOST}}{An host name is required for this protocol.}
  80 \twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.}
  81 \twocolitem{{\bf wxURL\_CONNERR}}{Connection error.}
  82 \twocolitem{{\bf wxURL\_PROTOERR}}{An error occured during negotiation.}
  83 \end{twocollist}%
  84
  85 %
  86 % GetInputStream
  87 %
  88 \membersection{wxURL::GetInputStream}
  89
  90 \func{wxInputStream *}{GetInputStream}{\void}
  91
  92 Creates a new input stream on the the specified URL. You can use all but seek
  93 functionnality of wxStream. Seek isn't available on all stream. For example,
  94 http or ftp streams doesn't deal with it.
  95
  96 \wxheading{Return value}
  97
  98 Returns the initialized stream. You will have to delete it yourself.
  99
 100 \wxheading{See also}
 101
 102 %\helpref{wxInputStream}{wxinputstream}
 103 wxInputStream
 104
 105 %
 106 % SetDefaultProxy
 107 %
 108 \membersection{wxURL::SetDefaultProxy}\label{wxurlsetdefaultproxy}
 109
 110 \func{static void}{SetDefaultProxy}{\param{const wxString\&}{ url\_proxy}}
 111
 112 Sets the default proxy server to use to get the URL. The string specifies
 113 the proxy like this: <hostname>:<port number>.
 114
 115 \wxheading{Parameters}
 116
 117 \docparam{url\_proxy}{Specifies the proxy to use}
 118
 119 \wxheading{See also}
 120
 121 \helpref{wxURL::SetProxy}{wxurlsetproxy}
 122
 123 %
 124 % SetProxy
 125 %
 126 \membersection{wxURL::SetProxy}\label{wxurlsetproxy}
 127
 128 \func{void}{SetProxy}{\param{const wxString\&}{ url\_proxy}}
 129
 130 Sets the proxy to use for this URL.
 131
 132 \wxheading{See also}
 133
 134 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
 135