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