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

... / ...

Commit	Line	Data
	1	% -----------------------------------------------------------------------------
	2	% wxInputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxInputStream}}\label{wxinputstream}
	5
	6	wxInputStream is an abstract base class which may not be used directly.
	7
	8	\wxheading{Derived from}
	9
	10	\helpref{wxStreamBase}{wxstreambase}
	11
	12	\wxheading{Include files}
	13
	14	<wx/stream.h>
	15
	16	\latexignore{\rtfignore{\wxheading{Members}}}
	17
	18	% -----------
	19	% ctor & dtor
	20	% -----------
	21	\membersection{wxInputStream::wxInputStream}
	22
	23	\func{}{wxInputStream}{\void}
	24
	25	Creates a dummy input stream.
	26
	27	\membersection{wxInputStream::\destruct{wxInputStream}}
	28
	29	\func{}{\destruct{wxInputStream}}{\void}
	30
	31	Destructor.
	32
	33	\membersection{wxInputStream::GetC}
	34
	35	\func{char}{GetC}{\void}
	36
	37	Returns the first character in the input queue and removes it,
	38	blocking until it appears if necessary.
	39
	40	\wxheading{Note}
	41
	42	If EOF, return value is undefined and LastRead() will return 0 and not 1.
	43
	44	\membersection{wxInputStream::Eof}\label{wxinputstreameof}
	45
	46	\constfunc{wxInputStream}{Eof}{\void}
	47
	48	Returns true if the end of stream has been reached.
	49
	50	\wxheading{Note}
	51
	52	This cannot be really implemented for all streams and CanRead() is more
	53	reliable than Eof().
	54
	55	\membersection{wxInputStream::LastRead}\label{wxinputstreamlastread}
	56
	57	\constfunc{size\_t}{LastRead}{\void}
	58
	59	Returns the last number of bytes read.
	60
	61	\membersection{wxInputStream::Peek}
	62
	63	\func{char}{Peek}{\void}
	64
	65	Returns the first character in the input queue without removing it.
	66
	67	\wxheading{Note}
	68
	69	Blocks until something appears in the stream if necessary, if nothing
	70	ever does (i.e. EOF) LastRead() will return 0 (and the return value is
	71	undefined), otherwise LastRead() returns 1.
	72
	73	\membersection{wxInputStream::Read}
	74
	75	\func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}
	76
	77	Reads the specified amount of bytes and stores the data in {\it buffer}.
	78
	79	\wxheading{Warning}
	80
	81	The buffer absolutely needs to have at least the specified size.
	82
	83	\wxheading{Return value}
	84
	85	This function returns a reference on the current object, so the user can test
	86	any states of the stream right away.
	87
	88	\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}}
	89
	90	Reads data from the input queue and stores it in the specified output stream.
	91	The data is read until an error is raised by one of the two streams.
	92
	93	\wxheading{Return value}
	94
	95	This function returns a reference on the current object, so the user can test
	96	any states of the stream right away.
	97
	98	\membersection{wxInputStream::SeekI}\label{wxinputstreamseeki}
	99
	100	\func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
	101
	102	Changes the stream current position.
	103
	104	\wxheading{Parameters}
	105
	106	\docparam{pos}{Offset to seek to.}
	107
	108	\docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}
	109
	110	\wxheading{Return value}
	111
	112	The new stream position or wxInvalidOffset on error.
	113
	114	\membersection{wxInputStream::TellI}
	115
	116	\constfunc{off\_t}{TellI}{\void}
	117
	118	Returns the current stream position.
	119
	120	\membersection{wxInputStream::Ungetch}\label{wxinputstreamungetch}
	121
	122	\func{size\_t}{Ungetch}{\param{const char*}{ buffer}, \param{size\_t}{ size}}
	123
	124	This function is only useful in {\it read} mode. It is the manager of the "Write-Back"
	125	buffer. This buffer acts like a temporary buffer where data which has to be
	126	read during the next read IO call are put. This is useful when you get a big
	127	block of data which you didn't want to read: you can replace them at the top
	128	of the input queue by this way.
	129
	130	Be very careful about this call in connection with calling SeekI() on the same
	131	stream. Any call to SeekI() will invalidate any previous call to this method
	132	(otherwise you could SeekI() to one position, "unread" a few bytes there, SeekI()
	133	to another position and data would be either lost or corrupted).
	134
	135	\wxheading{Return value}
	136
	137	Returns the amount of bytes saved in the Write-Back buffer.
	138
	139	\func{bool}{Ungetch}{\param{char }{c}}
	140
	141	This function acts like the previous one except that it takes only one
	142	character: it is sometimes shorter to use than the generic function.
	143