splitted wxFileStream docs in 2 files to make the classes appear in the alphabetic order (patch 549657)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15332 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2002-05-02 13:36:23 +00:00
parent 17046ed61e
commit 1106d8654d
4 changed files with 126 additions and 124 deletions

View File

@@ -54,10 +54,10 @@
\input custdobj.tex \input custdobj.tex
\input database.tex \input database.tex
\input dataform.tex \input dataform.tex
\input dobjcomp.tex
\input dobjsmpl.tex
\input datistrm.tex \input datistrm.tex
\input dataobj.tex \input dataobj.tex
\input dobjcomp.tex
\input dobjsmpl.tex
\input datostrm.tex \input datostrm.tex
\input date.tex \input date.tex
\input datespan.tex \input datespan.tex
@@ -95,12 +95,14 @@
\input ffile.tex \input ffile.tex
\input ffilestr.tex \input ffilestr.tex
\input file.tex \input file.tex
\input filestrm.tex
\input fildatob.tex \input fildatob.tex
\input filedlg.tex \input filedlg.tex
\input fildrptg.tex \input fildrptg.tex
\input filehist.tex \input filehist.tex
\input fileistr.tex
\input filename.tex \input filename.tex
\input fileostr.tex
\input filestrm.tex
% Deprecated % Deprecated
%\input propflva.tex %\input propflva.tex
\input filesys.tex \input filesys.tex
@@ -270,8 +272,8 @@
\input screendc.tex \input screendc.tex
\input scrolbar.tex \input scrolbar.tex
\input scrolwin.tex \input scrolwin.tex
\input scrlwevt.tex
\input scrolevt.tex \input scrolevt.tex
\input scrlwevt.tex
\input semaphor.tex \input semaphor.tex
\input hprovsmp.tex \input hprovsmp.tex
\input sngchdlg.tex \input sngchdlg.tex

View File

@@ -0,0 +1,58 @@
\section{\class{wxFileInputStream}}\label{wxfileinputstream}
This class represents data read in from a file. There are actually
two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
the \helpref{wxFFile}{wxffile} class.
Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
in one aspect, namely when to report that the end of the file has been
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
classes reflects this difference, i.e. wxFileInputStream will report
wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
\wxheading{Derived from}
\helpref{wxInputStream}{wxinputstream}
\wxheading{Include files}
<wx/wfstream.h>
\wxheading{See also}
\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFileInputStream::wxFileInputStream}
\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
Opens the specified file using its {\it ifilename} name in read-only mode.
\func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
Initializes a file stream in read-only mode using the file I/O object {\it file}.
\func{}{wxFileInputStream}{\param{int}{ fd}}
Initializes a file stream in read-only mode using the specified file descriptor.
\membersection{wxFileInputStream::\destruct{wxFileInputStream}}
\func{}{\destruct{wxFileInputStream}}{\void}
Destructor.
\membersection{wxFileInputStream::Ok}
\constfunc{bool}{Ok}{\void}
Returns TRUE if the stream is initialized and ready.

View File

@@ -0,0 +1,62 @@
% -----------------------------------------------------------------------------
% wxFileOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
This class represents data written to a file. There are actually
two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
the \helpref{wxFFile}{wxffile} class.
Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
in one aspect, namely when to report that the end of the file has been
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
classes reflects this difference, i.e. wxFileInputStream will report
wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
\wxheading{Derived from}
\helpref{wxOutputStream}{wxoutputstream}
\wxheading{Include files}
<wx/wfstream.h>
\wxheading{See also}
\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFileOutputStream::wxFileOutputStream}
\func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
Creates a new file with {\it ofilename} name and initializes the stream in
write-only mode.
\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
Initializes a file stream in write-only mode using the file I/O object {\it file}.
\func{}{wxFileOutputStream}{\param{int}{ fd}}
Initializes a file stream in write-only mode using the file descriptor {\it fd}.
\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
\func{}{\destruct{wxFileOutputStream}}{\void}
Destructor.
\membersection{wxFileOutputStream::Ok}
\constfunc{bool}{Ok}{\void}
Returns TRUE if the stream is initialized and ready.

View File

@@ -1,123 +1,3 @@
\section{\class{wxFileInputStream}}\label{wxfileinputstream}
This class represents data read in from a file. There are actually
two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
the \helpref{wxFFile}{wxffile} class.
Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
in one aspect, namely when to report that the end of the file has been
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
classes reflects this difference, i.e. wxFileInputStream will report
wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
\wxheading{Derived from}
\helpref{wxInputStream}{wxinputstream}
\wxheading{Include files}
<wx/wfstream.h>
\wxheading{See also}
\helpref{wxBufferedInputStream}{wxbufferedinputstream}, \helpref{wxFileOutputStream}{wxfileoutputstream}, \helpref{wxFFileOutputStream}{wxffileoutputstream}
% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFileInputStream::wxFileInputStream}
\func{}{wxFileInputStream}{\param{const wxString\&}{ ifileName}}
Opens the specified file using its {\it ifilename} name in read-only mode.
\func{}{wxFileInputStream}{\param{wxFile\&}{ file}}
Initializes a file stream in read-only mode using the file I/O object {\it file}.
\func{}{wxFileInputStream}{\param{int}{ fd}}
Initializes a file stream in read-only mode using the specified file descriptor.
\membersection{wxFileInputStream::\destruct{wxFileInputStream}}
\func{}{\destruct{wxFileInputStream}}{\void}
Destructor.
\membersection{wxFileInputStream::Ok}
\constfunc{bool}{Ok}{\void}
Returns TRUE if the stream is initialized and ready.
% -----------------------------------------------------------------------------
% wxFileOutputStream
% -----------------------------------------------------------------------------
\section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
This class represents data written to a file. There are actually
two such groups of classes: this one is based on \helpref{wxFile}{wxfile}
whereas \helpref{wxFFileInputStream}{wxffileinputstream} is based in
the \helpref{wxFFile}{wxffile} class.
Note that \helpref{wxFile}{wxfile} and \helpref{wxFFile}{wxffile} differ
in one aspect, namely when to report that the end of the file has been
reached. This is documented in \helpref{wxFile::Eof}{wxfileeof} and
\helpref{wxFFile::Eof}{wxffileeof} and the behaviour of the stream
classes reflects this difference, i.e. wxFileInputStream will report
wxSTREAM\_EOF after having read the last byte whereas wxFFileInputStream
will report wxSTREAM\_EOF after trying to read {\it past} the last byte.
\wxheading{Derived from}
\helpref{wxOutputStream}{wxoutputstream}
\wxheading{Include files}
<wx/wfstream.h>
\wxheading{See also}
\helpref{wxBufferedOutputStream}{wxbufferedoutputstream}, \helpref{wxFileInputStream}{wxfileinputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
% ----------
% Members
% ----------
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFileOutputStream::wxFileOutputStream}
\func{}{wxFileOutputStream}{\param{const wxString\&}{ ofileName}}
Creates a new file with {\it ofilename} name and initializes the stream in
write-only mode.
\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
Initializes a file stream in write-only mode using the file I/O object {\it file}.
\func{}{wxFileOutputStream}{\param{int}{ fd}}
Initializes a file stream in write-only mode using the file descriptor {\it fd}.
\membersection{wxFileOutputStream::\destruct{wxFileOutputStream}}
\func{}{\destruct{wxFileOutputStream}}{\void}
Destructor.
\membersection{wxFileOutputStream::Ok}
\constfunc{bool}{Ok}{\void}
Returns TRUE if the stream is initialized and ready.
% ----------------------------------------------------------------------------- % -----------------------------------------------------------------------------
% wxFileStream % wxFileStream
% ----------------------------------------------------------------------------- % -----------------------------------------------------------------------------