docs/latex/wx/url.tex

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