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

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

\wxheading{Derived from}

\helpref{wxStreamBase}{wxstreambase}

\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.

% -----------
% IO function
% -----------
\membersection{wxInputStream::Peek}

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

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

\membersection{wxInputStream::GetC}

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

Returns the first character in the input queue and removes 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}.

\it{WARNING!} The buffer absolutely needs to have at least the specified size.

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.

% ------------------
% Position functions
% ------------------
\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.

% ---------------
% State functions
% ---------------
\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.
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
	10	\wxheading{See also}
	11
	12	\helpref{wxStreamBuffer}{wxstreambuffer}
	13
	14	% -----------
	15	% ctor & dtor
	16	% -----------
	17	\membersection{wxInputStream::wxInputStream}
	18
	19	\func{}{wxInputStream}{\void}
	20
	21	Creates a dummy input stream.
	22
	23	\func{}{wxInputStream}{\param{wxStreamBuffer *}{sbuf}}
	24
	25	Creates an input stream using the specified stream buffer \it{sbuf}. This
	26	stream buffer can point to another stream.
	27
	28	\membersection{wxInputStream::\destruct{wxInputStream}}
	29
	30	\func{}{\destruct{wxInputStream}}{\void}
	31
	32	Destructor.
	33
	34	% -----------
	35	% IO function
	36	% -----------
	37	\membersection{wxInputStream::Peek}
	38
	39	\func{char}{Peek}{\void}
	40
	41	Returns the first character in the input queue without removing it.
	42
	43	\membersection{wxInputStream::GetC}
	44
	45	\func{char}{GetC}{\void}
	46
	47	Returns the first character in the input queue and removes it.
	48
	49	\membersection{wxInputStream::Read}
	50
	51	\func{wxInputStream\&}{Read}{\param{void *}{buffer}, \param{size_t}{ size}}
	52
	53	Reads the specified amount of bytes and stores the data in \it{buffer}.
	54
	55	\it{WARNING!} The buffer absolutely needs to have at least the specified size.
	56
	57	This function returns a reference on the current object, so the user can test
	58	any states of the stream right away.
	59
	60	\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream_out}}
	61
	62	Reads data from the input queue and stores it in the specified output stream.
	63	The data is read until an error is raised by one of the two streams.
	64
65	% ------------------
66	% Position functions
67	% ------------------
68	\membersection{wxInputStream::SeekI}
69
70	\func{off_t}{SeekI}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode = wxFromStart}}
71
72	Changes the stream current position.
73
74	\membersection{wxInputStream::TellI}
75
76	\constfunc{off_t}{TellI}{\void}
77
78	Returns the current stream position.
79
80	% ---------------
81	% State functions
82	% ---------------
83	\membersection{wxInputStream::InputStreamBuffer}
84
85	\func{wxStreamBuffer*}{InputStreamBuffer}{\void}
86
87	Returns the stream buffer associated with the input stream.
88
89	\membersection{wxInputStream::LastRead}
90
91	\constfunc{size_t}{LastRead}{\void}
92
93	Returns the last number of bytes read.
94