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{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
  19 \wxheading{Include files}
  20
  21 <wx/wfstream.h>
  22
  23 \wxheading{Library}
  24
  25 \helpref{wxBase}{librarieslist}
  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}\label{wxffileinputstreamctor}
  37
  38 \func{}{wxFFileInputStream}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode = "rb"}}
  39
  40 Opens the specified file using its {\it filename} name using the specified 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}}\label{wxffileinputstreamdtor}
  51
  52 \func{}{\destruct{wxFFileInputStream}}{\void}
  53
  54 Destructor.
  55
  56 \membersection{wxFFileInputStream::IsOk}\label{wxffileinputstreamisok}
  57
  58 \constfunc{bool}{IsOk}{\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{SeekO()}{wxoutputstreamseeko}
  73 can seek beyond the end of the stream (file) and will thus not return
  74 {\it wxInvalidOffset} for that.
  75
  76 \wxheading{Derived from}
  77
  78 \helpref{wxOutputStream}{wxoutputstream}
  79
  80 \wxheading{Include files}
  81
  82 <wx/wfstream.h>
  83
  84 \wxheading{Library}
  85
  86 \helpref{wxBase}{librarieslist}
  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}\label{wxffileoutputstreamctor}
  98
  99 \func{}{wxFFileOutputStream}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode="w+b"}}
 100
 101 Opens the file with the given {\it filename} name in the specified mode.
 102
 103 \func{}{wxFFileOutputStream}{\param{wxFFile\&}{ file}}
 104
 105 Initializes a file stream in write-only mode using the file I/O object {\it file}.
 106
 107 \func{}{wxFFileOutputStream}{\param{FILE *}{ fp}}
 108
 109 Initializes a file stream in write-only mode using the file descriptor {\it fp}.
 110
 111 \membersection{wxFFileOutputStream::\destruct{wxFFileOutputStream}}\label{wxffileoutputstreamdtor}
 112
 113 \func{}{\destruct{wxFFileOutputStream}}{\void}
 114
 115 Destructor.
 116
 117 \membersection{wxFFileOutputStream::IsOk}\label{wxffileoutputstreamisok}
 118
 119 \constfunc{bool}{IsOk}{\void}
 120
 121 Returns true if the stream is initialized and ready.
 122
 123 % -----------------------------------------------------------------------------
 124 % wxFFileStream
 125 % -----------------------------------------------------------------------------
 126 \section{\class{wxFFileStream}}\label{wxffilestream}
 127
 128 \wxheading{Derived from}
 129
 130 \helpref{wxFFileOutputStream}{wxffileoutputstream}, \helpref{wxFFileInputStream}{wxffileinputstream}
 131
 132 \wxheading{Include files}
 133
 134 <wx/wfstream.h>
 135
 136 \wxheading{Library}
 137
 138 \helpref{wxBase}{librarieslist}
 139
 140 \wxheading{See also}
 141
 142 \helpref{wxStreamBuffer}{wxstreambuffer}
 143
 144 \latexignore{\rtfignore{\wxheading{Members}}}
 145
 146 \membersection{wxFFileStream::wxFFileStream}\label{wxffilestreamctor}
 147
 148 \func{}{wxFFileStream}{\param{const wxString\&}{ iofileName}}
 149
 150 Initializes a new file stream in read-write mode using the specified
 151 {\it iofilename} name.
 152
 153