docs/latex/wx/tfile.tex

   1 \section{File classes and functions overview}\label{wxfileoverview}
   2
   3 Classes: \helpref{wxFile}{wxfile}, \helpref{wxDir}{wxdir}, \helpref{wxTempFile}{wxtempfile},
   4 \helpref{wxTextFile}{wxtextfile}
   5
   6 Functions: see \helpref{file functions}{filefunctions}.
   7
   8 wxWidgets provides some functions and classes to facilitate working with files.
   9 As usual, the accent is put on cross-platform features which explains, for
  10 example, the \helpref{wxTextFile}{wxtextfile} class which may be used to convert
  11 between different types of text files (DOS/Unix/Mac).
  12
  13 wxFile may be used for low-level IO. It contains all the usual functions to work
  14 with files (opening/closing, reading/writing, seeking, and so on) but compared with
  15 using standard C functions, has error checking (in case of an error a message
  16 is logged using \helpref{wxLog}{wxlog} facilities) and closes the file
  17 automatically in the destructor which may be quite convenient.
  18
  19 wxTempFile is a very small file designed to make replacing the files contents
  20 safer - see its \helpref{documentation}{wxtempfile} for more details.
  21
  22 wxTextFile is a general purpose class for working with small text files on line
  23 by line basis. It is especially well suited for working with configuration files
  24 and program source files. It can be also used to work with files with "non
  25 native" line termination characters and write them as "native" files if needed
  26 (in fact, the files may be written in any format).
  27
  28 wxDir is a helper class for enumerating the files or subdirectories of a
  29 directory. It may be used to enumerate all files, only files satisfying the
  30 given template mask or only non-hidden files.
  31