1 \section{\class{wxURL
}}\label{wxurl
}
3 \wxheading{Derived from
}
5 \helpref{wxObject
}{wxobject
}
9 \helpref{wxSocketBase
}{wxsocketbase
},
\helpref{wxProtocol
}{wxprotocol
}
11 % ----------------------------------------------------------------------------
13 % ----------------------------------------------------------------------------
15 \latexignore{\rtfignore{\membersection{Members
}}}
17 \membersection{wxURL::wxURL
}{wxurlconstr
}
18 \func{}{wxURL
}{\param{const wxString\&
}{ url
}}
20 Constructs an URL object from the string.
22 \wxheading{Parameters
}
24 \docparam{url
}{Url string to parse.
}
26 \membersection{wxURL::
\destruct{wxURL
}}
27 \func{}{\destruct{wxURL
}}{\void}
29 Destroys the URL object.
34 \membersection{wxURL::GetProtocolName
}
35 \constfunc{wxString
}{GetProtocolName
}{\void}
37 Returns the name of the protocol which will be used to get the URL.
42 \membersection{wxURL::GetProtocol
}
43 \func{wxProtocol\&
}{GetProtocol
}{\void}
45 Returns a reference to the protocol which will be used to get the URL.
50 \membersection{wxURL::GetError
}
51 \constfunc{wxURLError
}{GetError
}{\void}
53 Returns the last error. This error refers to the URL parsing or to the protocol.
54 It can be one of these errors:
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.
}
70 \membersection{wxURL::GetInputStream
}
71 \func{wxInputStream *
}{GetInputStream
}{\void}
73 Initializes the protocol and opens the input stream.
75 \wxheading{Return value:
}
77 It returns a read-only wxStream.
81 \helpref{wxInputStream
}{wxinputstream
}
86 \membersection{wxURL::SetDefaultProxy
}{wxurlsetdefaultproxy
}
87 \func{static void
}{SetDefaultProxy
}{\param{const wxString\&
}{ url
\_proxy}}
89 Sets the default proxy server to use to get the URL. The string specifies
90 the proxy like this: <hostname>:<port number>.
92 \wxheading{Parameters
}
94 \docparam{url
\_proxy}{Specifies the proxy to use
}
98 \helpref{wxURL::SetProxy
}{wxurlsetproxy
}
103 \membersection{wxURL::SetProxy
}{wxurlsetproxy
}
104 \func{void
}{SetProxy
}{\param{const wxString\&
}{ url
\_proxy}}
106 Sets the proxy to use for this URL.
110 \helpref{wxURL::SetDefaultProxy
}{wxurlsetdefaultproxy
}