git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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	\latexignore{\rtfignore{\membersection{Members}}}
	15
	16	\membersection{wxURL::wxURL}\label{wxurlconstr}
	17
	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
	28	\func{}{\destruct{wxURL}}{\void}
	29
	30	Destroys the URL object.
	31
	32	%
	33	% GetProtocolName
	34	%
	35	\membersection{wxURL::GetProtocolName}
	36
	37	\constfunc{wxString}{GetProtocolName}{\void}
	38
	39	Returns the name of the protocol which will be used to get the URL.
	40
	41	%
	42	% GetProtocol
	43	%
	44	\membersection{wxURL::GetProtocol}
	45
	46	\func{wxProtocol\&}{GetProtocol}{\void}
	47
	48	Returns a reference to the protocol which will be used to get the URL.
	49
	50	%
	51	% GetError
	52	%
	53	\membersection{wxURL::GetError}
	54
	55	\constfunc{wxURLError}{GetError}{\void}
	56
	57	Returns the last error. This error refers to the URL parsing or to the protocol.
	58	It can be one of these errors:
	59
	60	\twocolwidtha{7cm}
	61	\begin{twocollist}\itemsep=0pt%
	62	\twocolitem{{\bf wxURL\_NOERR}}{No error.}
	63	\twocolitem{{\bf wxURL\_SNTXERR}}{Syntax error in the URL string.}
	64	\twocolitem{{\bf wxURL\_NOPROTO}}{Found no protocol which can get this URL.}
	65	\twocolitem{{\bf wxURL\_NOHOST}}{An host name is required for this protocol.}
	66	\twocolitem{{\bf wxURL\_NOPATH}}{A path is required for this protocol.}
	67	\twocolitem{{\bf wxURL\_CONNERR}}{Connection error.}
	68	\twocolitem{{\bf wxURL\_PROTOERR}}{An error occured during negotiation.}
	69	\end{twocollist}%
	70
	71	%
	72	% GetInputStream
	73	%
	74	\membersection{wxURL::GetInputStream}
	75
	76	\func{wxInputStream *}{GetInputStream}{\void}
	77
	78	Creates a new input stream on the the specified URL. You can use all but seek
	79	functionnality of wxStream. Seek isn't available on all stream. For example,
	80	http or ftp streams doesn't deal with it.
	81
	82	\wxheading{Return value}
	83
	84	Returns the initialized stream. You will have to delete it yourself.
	85
	86	\wxheading{See also}
	87
	88	%\helpref{wxInputStream}{wxinputstream}
	89	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