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}{wxurlconstr}
  18 \func{}{wxURL}{\param{const wxString\&}{ url}}
  19
  20 Constructs an URL object from the string.
  21
  22 \wxheading{Parameters}
  23
  24 \docparam{url}{Url string to parse.}
  25
  26 \membersection{wxURL::\destruct{wxURL}}
  27 \func{}{\destruct{wxURL}}{\void}
  28
  29 Destroys the URL object.
  30
  31 %
  32 % GetProtocolName
  33 %
  34 \membersection{wxURL::GetProtocolName}
  35 \constfunc{wxString}{GetProtocolName}{\void}
  36
  37 Returns the name of the protocol which will be used to get the URL.
  38
  39 %
  40 % GetProtocol
  41 %
  42 \membersection{wxURL::GetProtocol}
  43 \func{wxProtocol\&}{GetProtocol}{\void}
  44
  45 Returns a reference to the protocol which will be used to get the URL.
  46
  47 %
  48 % GetError
  49 %
  50 \membersection{wxURL::GetError}
  51 \constfunc{wxURLError}{GetError}{\void}
  52
  53 Returns the last error. This error refers to the URL parsing or to the protocol.
  54 It can be one of these errors:
  55
  56 \twocolwidtha{7cm}
  57 \begin{twocollist}\itemsep=0pt
  58 \twocolitem{{\bf wxURL\_NOERR}}{No error.}
  59 \twocolitem{{\bf wxURL\_SNTXERR}}{Syntax error in the URL string.}
  60 \twocolitem{{\bf wxURL\_NOPROTO}}{Found no protocol which can get this URL.}
  61 \twocolitem{{\bf wxURL\_NOHOST}}{An host name is required for this protocol.}
  62 \twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.}
  63 \twocolitem{{\bf wxURL\_CONNERR}}{Connection error.}
  64 \twocolitem{{\bf wxURL\_PROTOERR}}{An error occured during negotiation.}
  65 \end{twocollist}%
  66
  67 %
  68 % GetInputStream
  69 %
  70 \membersection{wxURL::GetInputStream}
  71 \func{wxInputStream *}{GetInputStream}{\void}
  72
  73 Initializes the protocol and opens the input stream.
  74
  75 \wxheading{Return value:}
  76
  77 It returns a read-only wxStream.
  78
  79 \wxheading{See also:}
  80
  81 \helpref{wxInputStream}{wxinputstream}
  82
  83 %
  84 % SetDefaultProxy
  85 %
  86 \membersection{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}
  87 \func{static void}{SetDefaultProxy}{\param{const wxString\&}{ url\_proxy}}
  88
  89 Sets the default proxy server to use to get the URL. The string specifies
  90 the proxy like this: <hostname>:<port number>.
  91
  92 \wxheading{Parameters}
  93
  94 \docparam{url\_proxy}{Specifies the proxy to use}
  95
  96 \wxheading{See also}
  97
  98 \helpref{wxURL::SetProxy}{wxurlsetproxy}
  99
 100 %
 101 % SetProxy
 102 %
 103 \membersection{wxURL::SetProxy}{wxurlsetproxy}
 104 \func{void}{SetProxy}{\param{const wxString\&}{ url\_proxy}}
 105
 106 Sets the proxy to use for this URL.
 107
 108 \wxheading{See also}
 109
 110 \helpref{wxURL::SetDefaultProxy}{wxurlsetdefaultproxy}