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

... / ...

Commit	Line	Data
	1	\section{\class{wxFileInputStream}}\label{wxfileinputstream}
	2
	3	This class represents data read in from a file. There are actually
	4	two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
	5	whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
	6	the \helpref{wxFFile}{wxffile} class.
	7
	8	Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
	9	in one aspect, namely when to report that the end of the file has been
	10	reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
	11	\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
	12	classes reflects this difference, i.e. wxFileInputStream will report
	13	wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
	14	will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
	15
	16	\wxheading{Derived from}
	17
	18	\helpref{wxInputStream}{wxinputstream}
	19
	20	\wxheading{Include files}
	21
	22	<wx/wfstream.h>
	23
	24	\wxheading{See also}
	25
	26	\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
	27
	28	% ----------
	29	% Members
	30	% ----------
	31	\latexignore{\rtfignore{\wxheading{Members}}}
	32
	33	\membersection{wxFileInputStream::wxFileInputStream}
	34
	35	\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
	36
	37	Opens the specified file using its {\it ifilename} name in read-only mode.
	38
	39	\func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
	40
	41	Initializes a file stream in read-only mode using the file I/O object {\it file}.
	42
	43	\func{}{wxFileInputStream}{\param{int}{ fd}}
	44
	45	Initializes a file stream in read-only mode using the specified file descriptor.
	46
	47	\membersection{wxFileInputStream::\destruct{wxFileInputStream}}
	48
	49	\func{}{\destruct{wxFileInputStream}}{\void}
	50
	51	Destructor.
	52
	53	\membersection{wxFileInputStream::Ok}
	54
	55	\constfunc{bool}{Ok}{\void}
	56
	57	Returns TRUE if the stream is initialized and ready.
	58
	59	% -----------------------------------------------------------------------------
	60	% wxFileOutputStream
	61	% -----------------------------------------------------------------------------
	62	\section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
	63
	64	This class represents data written to a file. There are actually
	65	two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
	66	whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
	67	the \helpref{wxFFile}{wxffile} class.
	68
	69	Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
	70	in one aspect, namely when to report that the end of the file has been
	71	reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
	72	\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
	73	classes reflects this difference, i.e. wxFileInputStream will report
	74	wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
	75	will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
	76
	77	\wxheading{Derived from}
	78
	79	\helpref{wxOutputStream}{wxoutputstream}
	80
	81	\wxheading{Include files}
	82
	83	<wx/wfstream.h>
	84
	85	\wxheading{See also}
	86
	87	\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
	88
	89	% ----------
	90	% Members
	91	% ----------
	92	\latexignore{\rtfignore{\wxheading{Members}}}
	93
	94	\membersection{wxFileOutputStream::wxFileOutputStream}
	95
	96	\func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
	97
	98	Creates a new file with {\it ofilename} name and initializes the stream in
	99	write-only mode.
	100
	101	\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
	102
	103	Initializes a file stream in write-only mode using the file I/O object {\it file}.
	104
	105	\func{}{wxFileOutputStream}{\param{int}{ fd}}
	106
	107	Initializes a file stream in write-only mode using the file descriptor {\it fd}.
	108
	109	\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
	110
	111	\func{}{\destruct{wxFileOutputStream}}{\void}
	112
	113	Destructor.
	114
	115	\membersection{wxFileOutputStream::Ok}
	116
	117	\constfunc{bool}{Ok}{\void}
	118
	119	Returns TRUE if the stream is initialized and ready.
	120
	121	% -----------------------------------------------------------------------------
	122	% wxFileStream
	123	% -----------------------------------------------------------------------------
	124	\section{\class{wxFileStream}}
	125
	126	\wxheading{Derived from}
	127
	128	\helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
	129
	130	\wxheading{Include files}
	131
	132	<wx/wfstream.h>
	133
	134	\wxheading{See also}
	135
	136	\helpref{wxStreamBuffer}{wxstreambuffer}
	137
	138	\latexignore{\rtfignore{\wxheading{Members}}}
	139
	140	\membersection{wxFileStream::wxFileStream}
	141
	142	\func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}
	143
	144	Initializes a new file stream in read-write mode using the specified
	145	{\it iofilename} name.
	146