[wxWidgets.git] / docs / latex / wx / inputstr.tex

% -----------------------------------------------------------------------------
% wxInputStream
% -----------------------------------------------------------------------------
\section{\class{wxInputStream}}\label{wxinputstream}

\wxheading{Derived from}

\helpref{wxStreamBase}{wxstreambase}

\wxheading{Include files}

<wx/stream.h>

\wxheading{See also}

\helpref{wxStreamBuffer}{wxstreambuffer}

% -----------
% ctor & dtor
% -----------
\membersection{wxInputStream::wxInputStream}

\func{}{wxInputStream}{\void}

Creates a dummy input stream.

\func{}{wxInputStream}{\param{wxStreamBuffer *}{sbuf}}

Creates an input stream using the specified stream buffer \it{sbuf}. This
stream buffer can point to another stream.

\membersection{wxInputStream::\destruct{wxInputStream}}

\func{}{\destruct{wxInputStream}}{\void}

Destructor.

\membersection{wxInputStream::GetC}

\func{char}{GetC}{\void}

Returns the first character in the input queue and removes it.

\membersection{wxInputStream::InputStreamBuffer}

\func{wxStreamBuffer*}{InputStreamBuffer}{\void}

Returns the stream buffer associated with the input stream.

\membersection{wxInputStream::LastRead}

\constfunc{size\_t}{LastRead}{\void}

Returns the last number of bytes read.

\membersection{wxInputStream::Peek}

\func{char}{Peek}{\void}

Returns the first character in the input queue without removing it.

\membersection{wxInputStream::Read}

\func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}

Reads the specified amount of bytes and stores the data in \it{buffer}.

\wxheading{Warning}

The buffer absolutely needs to have at least the specified size.

\wxheading{Return value}

This function returns a reference on the current object, so the user can test
any states of the stream right away.

\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}}

Reads data from the input queue and stores it in the specified output stream.
The data is read until an error is raised by one of the two streams.

\wxheading{Return value}

This function returns a reference on the current object, so the user can test
any states of the stream right away.

\membersection{wxInputStream::SeekI}

\func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}

Changes the stream current position.

\membersection{wxInputStream::TellI}

\constfunc{off\_t}{TellI}{\void}

Returns the current stream position.
Commit	Line	Data
e2a6f233 JS	1	% -----------------------------------------------------------------------------
	2	% wxInputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxInputStream}}\label{wxinputstream}
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxStreamBase}{wxstreambase}
	9
954b8ae6 JS	10	\wxheading{Include files}
	11
	12	<wx/stream.h>
	13
e2a6f233 JS	14	\wxheading{See also}
	15
	16	\helpref{wxStreamBuffer}{wxstreambuffer}
	17
	18	% -----------
	19	% ctor & dtor
	20	% -----------
	21	\membersection{wxInputStream::wxInputStream}
	22
	23	\func{}{wxInputStream}{\void}
	24
	25	Creates a dummy input stream.
	26
	27	\func{}{wxInputStream}{\param{wxStreamBuffer *}{sbuf}}
	28
	29	Creates an input stream using the specified stream buffer \it{sbuf}. This
	30	stream buffer can point to another stream.
	31
	32	\membersection{wxInputStream::\destruct{wxInputStream}}
	33
	34	\func{}{\destruct{wxInputStream}}{\void}
	35
	36	Destructor.
	37
e2a6f233 JS	38	\membersection{wxInputStream::GetC}
	39
	40	\func{char}{GetC}{\void}
	41
	42	Returns the first character in the input queue and removes it.
	43
40b480c3 JS	44	\membersection{wxInputStream::InputStreamBuffer}
	45
	46	\func{wxStreamBuffer*}{InputStreamBuffer}{\void}
	47
	48	Returns the stream buffer associated with the input stream.
	49
	50	\membersection{wxInputStream::LastRead}
	51
	52	\constfunc{size\_t}{LastRead}{\void}
	53
	54	Returns the last number of bytes read.
	55
	56	\membersection{wxInputStream::Peek}
	57
	58	\func{char}{Peek}{\void}
	59
	60	Returns the first character in the input queue without removing it.
	61
e2a6f233 JS	62	\membersection{wxInputStream::Read}
e2a6f233 JS	63
40b480c3	64	\func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size\_t}{ size}}
e2a6f233 JS	65
	66	Reads the specified amount of bytes and stores the data in \it{buffer}.
	67
da3aea64 GL	68	\wxheading{Warning}
	69
	70	The buffer absolutely needs to have at least the specified size.
	71
	72	\wxheading{Return value}
e2a6f233 JS	73
	74	This function returns a reference on the current object, so the user can test
	75	any states of the stream right away.
	76
294e9a7a	77	\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}}
e2a6f233 JS	78
	79	Reads data from the input queue and stores it in the specified output stream.
	80	The data is read until an error is raised by one of the two streams.
	81
da3aea64 GL	82	\wxheading{Return value}
	83
	84	This function returns a reference on the current object, so the user can test
	85	any states of the stream right away.
	86
e2a6f233 JS	87	\membersection{wxInputStream::SeekI}
e2a6f233 JS	88
40b480c3	89	\func{off\_t}{SeekI}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
e2a6f233 JS	90
	91	Changes the stream current position.
	92
	93	\membersection{wxInputStream::TellI}
	94
40b480c3	95	\constfunc{off\_t}{TellI}{\void}
e2a6f233 JS	96
	97	Returns the current stream position.
	98