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

... / ...

Commit	Line	Data
	1	% -----------------------------------------------------------------------------
	2	% wxFileInputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxFileInputStream}}\label{wxfileinputstream}
	5
	6	This class represents data read in from a file. There are actually
	7	two such groups of classes: those documented here, and another group called
	8	wxFFileInputStream, wxFFileOutputStream and wxFFileStream which are not
	9	based on file descriptors (and their wxWindows equivalent wxFile) but the
	10	FILE* type (and wxFFile). Apart from the different constructor ("FILE *file"
	11	instead if "int fd") their interface is identical.
	12
	13	\wxheading{Derived from}
	14
	15	\helpref{wxInputStream}{wxinputstream}
	16
	17	\wxheading{Include files}
	18
	19	<wx/wfstream.h>
	20
	21	\wxheading{See also}
	22
	23	\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxFileOutputStream}{wxfileoutputstream}
	24
	25	% ----------
	26	% Members
	27	% ----------
	28	\latexignore{\rtfignore{\wxheading{Members}}}
	29
	30	\membersection{wxFileInputStream::wxFileInputStream}
	31
	32	\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
	33
	34	Opens the specified file using its \it{ifilename} name in read-only mode.
	35
	36	\func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
	37
	38	Initializes a file stream in read-only mode using the file I/O object \it{file}.
	39
	40	\func{}{wxFileInputStream}{\param{int}{ fd}}
	41
	42	Initializes a file stream in read-only mode using the specified file descriptor.
	43
	44	\membersection{wxFileInputStream::\destruct{wxFileInputStream}}
	45
	46	\func{}{\destruct{wxFileInputStream}}{\void}
	47
	48	Destructor.
	49
	50	\membersection{wxFileInputStream::Ok}
	51
	52	\constfunc{bool}{Ok}{\void}
	53
	54	Returns TRUE if the stream is initialized and ready.
	55
	56	% -----------------------------------------------------------------------------
	57	% wxFileOutputStream
	58	% -----------------------------------------------------------------------------
	59	\section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
	60
	61	This class represents data written to a file. There are actually
	62	two such groups of classes: those documented here, and another group called
	63	wxFFileInputStream, wxFFileOutputStream and wxFFileStream which are not
	64	based on file descriptors (and their wxWindows equivalent wxFile) but the
	65	FILE* type (and wxFFile). Apart from the different constructor ("FILE *file"
	66	instead if "int fd") their interface is identical.
	67
	68	\wxheading{Derived from}
	69
	70	\helpref{wxOutputStream}{wxoutputstream}
	71
	72	\wxheading{Include files}
	73
	74	<wx/wfstream.h>
	75
	76	\wxheading{See also}
	77
	78	\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxFileInputStream}{wxfileinputstream}
	79
	80	% ----------
	81	% Members
	82	% ----------
	83	\latexignore{\rtfignore{\wxheading{Members}}}
	84
	85	\membersection{wxFileOutputStream::wxFileOutputStream}
	86
	87	\func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
	88
	89	Creates a new file with \it{ofilename} name and initializes the stream in
	90	write-only mode.
	91
	92	\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
	93
	94	Initializes a file stream in write-only mode using the file I/O object \it{file}.
	95
	96	\func{}{wxFileOutputStream}{\param{int}{ fd}}
	97
	98	Initializes a file stream in write-only mode using the file descriptor \it{fd}.
	99
	100	\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
	101
	102	\func{}{\destruct{wxFileOutputStream}}{\void}
	103
	104	Destructor.
	105
	106	\membersection{wxFileOutputStream::Ok}
	107
	108	\constfunc{bool}{Ok}{\void}
	109
	110	Returns TRUE if the stream is initialized and ready.
	111
	112	% -----------------------------------------------------------------------------
	113	% wxFileStream
	114	% -----------------------------------------------------------------------------
	115	\section{\class{wxFileStream}}
	116
	117	\wxheading{Derived from}
	118
	119	\helpref{wxFileOutputStream}{wxFileOutputStream}, \helpref{wxFileInputStream}{wxfileinputstream}
	120
	121	\wxheading{Include files}
	122
	123	<wx/wfstream.h>
	124
	125	\wxheading{See also}
	126
	127	\helpref{wxStreamBuffer}{wxstreamBuffer}
	128
	129	\latexignore{\rtfignore{\wxheading{Members}}}
	130
	131	\membersection{wxFileStream::wxFileStream}
	132
	133	\func{}{wxFileStream}{\param{const wxString\&}{ iofileName}}
	134
	135	Initializes a new file stream in read-write mode using the specified
	136	\it{iofilename} name.
	137