docs/latex/wx/ffilestr.tex

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