docs/doxygen/overviews/file.h

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