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