[wxWidgets.git] / docs / doxygen / overviews / file.h

/////////////////////////////////////////////////////////////////////////////
// Name:        file
// Purpose:     topic overview
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/*!

 @page file_overview File classes and functions overview

 Classes: #wxFile, #wxDir, #wxTempFile,
 #wxTextFile
 Functions: see @ref filefunctions_overview.
 wxWidgets provides some functions and classes to facilitate working with files.
 As usual, the accent is put on cross-platform features which explains, for
 example, the #wxTextFile class which may be used to convert
 between different types of text files (DOS/Unix/Mac).
 wxFile may be used for low-level IO. It contains all the usual functions to work
 with files (opening/closing, reading/writing, seeking, and so on) but compared with
 using standard C functions, has error checking (in case of an error a message
 is logged using #wxLog facilities) and closes the file
 automatically in the destructor which may be quite convenient.
 wxTempFile is a very small file designed to make replacing the files contents
 safer - see its #documentation for more details.
 wxTextFile is a general purpose class for working with small text files on line
 by line basis. It is especially well suited for working with configuration files
 and program source files. It can be also used to work with files with "non
 native" line termination characters and write them as "native" files if needed
 (in fact, the files may be written in any format).
 wxDir is a helper class for enumerating the files or subdirectories of a
 directory. It may be used to enumerate all files, only files satisfying the
 given template mask or only non-hidden files.

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