file.h 1.7 KB

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