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