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

... / ...

Commit	Line	Data
	1	% -----------------------------------------------------------------------------
	2	% wxFFileInputStream
	3	% -----------------------------------------------------------------------------
	4	\section{\class{wxFFileInputStream}}\label{wxffileinputstream}
	5
	6	This class represents data read in from a file. There are actually
	7	two such groups of classes: this one is based on \helpref{wxFFile}{wxffile}
	8	whereas \helpref{wxFileInputStream}{wxfileinputstream} is based in
	9	the \helpref{wxFile}{wxfile} class.
	10
	11	Note that \helpref{SeekI()}{wxinputstreamseeki}
	12	can seek beyond the end of the stream (file) and will thus not return
	13	{\it wxInvalidOffset} for that.
	14
	15	\wxheading{Derived from}
	16
	17	\helpref{wxInputStream}{wxinputstream}\\
	18	\helpref{wxStreamBase}{wxstreambase}
	19
	20	\wxheading{Include files}
	21
	22	<wx/wfstream.h>
	23
	24	\wxheading{Library}
	25
	26	\helpref{wxBase}{librarieslist}
	27
	28	\wxheading{See also}
	29
	30	\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}
	31
	32	% ----------
	33	% Members
	34	% ----------
	35	\latexignore{\rtfignore{\wxheading{Members}}}
	36
	37	\membersection{wxFFileInputStream::wxFFileInputStream}\label{wxffileinputstreamctor}
	38
	39	\func{}{wxFFileInputStream}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode = "rb"}}
	40
	41	Opens the specified file using its {\it filename} name using the specified mode.
	42
	43	\func{}{wxFFileInputStream}{\param{wxFFile\&}{ file}}
	44
	45	Initializes a file stream in read-only mode using the file I/O object {\it file}.
	46
	47	\func{}{wxFFileInputStream}{\param{FILE *}{ fp}}
	48
	49	Initializes a file stream in read-only mode using the specified file pointer {\it fp}.
	50
	51	\membersection{wxFFileInputStream::\destruct{wxFFileInputStream}}\label{wxffileinputstreamdtor}
	52
	53	\func{}{\destruct{wxFFileInputStream}}{\void}
	54
	55	Destructor.
	56
	57	\membersection{wxFFileInputStream::IsOk}\label{wxffileinputstreamisok}
	58
	59	\constfunc{bool}{IsOk}{\void}
	60
	61	Returns true if the stream is initialized and ready.
	62
	63	% -----------------------------------------------------------------------------
	64	% wxFFileOutputStream
	65	% -----------------------------------------------------------------------------
	66	\section{\class{wxFFileOutputStream}}\label{wxffileoutputstream}
	67
	68	This class represents data written to a file. There are actually
	69	two such groups of classes: this one is based on \helpref{wxFFile}{wxffile}
	70	whereas \helpref{wxFileInputStream}{wxffileinputstream} is based in
	71	the \helpref{wxFile}{wxfile} class.
	72
	73	Note that \helpref{SeekO()}{wxoutputstreamseeko}
	74	can seek beyond the end of the stream (file) and will thus not return
	75	{\it wxInvalidOffset} for that.
	76
	77	\wxheading{Derived from}
	78
	79	\helpref{wxOutputStream}{wxoutputstream}\\
	80	\helpref{wxStreamBase}{wxstreambase}
	81
	82	\wxheading{Include files}
	83
	84	<wx/wfstream.h>
	85
	86	\wxheading{Library}
	87
	88	\helpref{wxBase}{librarieslist}
	89
	90	\wxheading{See also}
	91
	92	\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}, \helpref{wxFileInputStream}{wxfileinputstream}
	93
	94	% ----------
	95	% Members
	96	% ----------
	97	\latexignore{\rtfignore{\wxheading{Members}}}
	98
	99	\membersection{wxFFileOutputStream::wxFFileOutputStream}\label{wxffileoutputstreamctor}
	100
	101	\func{}{wxFFileOutputStream}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode="w+b"}}
	102
	103	Opens the file with the given {\it filename} name in the specified mode.
	104
	105	\func{}{wxFFileOutputStream}{\param{wxFFile\&}{ file}}
	106
	107	Initializes a file stream in write-only mode using the file I/O object {\it file}.
	108
	109	\func{}{wxFFileOutputStream}{\param{FILE *}{ fp}}
	110
	111	Initializes a file stream in write-only mode using the file descriptor {\it fp}.
	112
	113	\membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}\label{wxffileoutputstreamdtor}
	114
	115	\func{}{\destruct{wxFFileOutputStream}}{\void}
	116
	117	Destructor.
	118
	119	\membersection{wxFFileOutputStream::IsOk}\label{wxffileoutputstreamisok}
	120
	121	\constfunc{bool}{IsOk}{\void}
	122
	123	Returns true if the stream is initialized and ready.
	124
	125	% -----------------------------------------------------------------------------
	126	% wxFFileStream
	127	% -----------------------------------------------------------------------------
	128	\section{\class{wxFFileStream}}\label{wxffilestream}
	129
	130	\wxheading{Derived from}
	131
	132	\helpref{wxFFileOutputStream}{wxffileoutputstream}\\
	133	\helpref{wxOutputStream}{wxoutputstream}\\
	134	\helpref{wxStreamBase}{wxstreambase}
	135
	136	\wxheading{Include files}
	137
	138	<wx/wfstream.h>
	139
	140	\wxheading{Library}
	141
	142	\helpref{wxBase}{librarieslist}
	143
	144	\wxheading{See also}
	145
	146	\helpref{wxStreamBuffer}{wxstreambuffer}
	147
	148	\latexignore{\rtfignore{\wxheading{Members}}}
	149
	150	\membersection{wxFFileStream::wxFFileStream}\label{wxffilestreamctor}
	151
	152	\func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}
	153
	154	Initializes a new file stream in read-write mode using the specified
	155	{\it iofilename} name.
	156
	157