[wxWidgets.git] / docs / latex / wx / tfile.tex

\section{File classes and functions overview}\label{wxfileoverview}

Classes: \helpref{wxFile}{wxfile}\\
\helpref{wxTempFile}{wxtempfile}\\
\helpref{wxTextFile}{wxtextfile}

Functions: see \helpref{file functions}{filefunctions}.

wxWindows 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 \helpref{wxTextFile}{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 usual functions to work
with files (opening/closing, reading/writing, seeking...) but, compared to
using standard C functions, brings error checking (in case of an error a message
is logged using \helpref{wxLog}{wxlog} facilities) and closes the file
automatically in destructor which may be quite convenient.

wxTempFile is a very small file designed to make replacing the files contents
safer - see its \helpref{documentation}{wxtempfile} 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).
Commit	Line	Data
7f561143 VZ	1	\section{File classes and functions overview}\label{wxfileoverview}
	2
	3	Classes: \helpref{wxFile}{wxfile}\\
	4	\helpref{wxTempFile}{wxtempfile}\\
	5	\helpref{wxTextFile}{wxtextfile}
	6
	7	Functions: see \helpref{file functions}{filefunctions}.
	8
	9	wxWindows provides some functions and classes to facilitate working with files.
	10	As usual, the accent is put on cross-platform features which explains, for
	11	example, the \helpref{wxTextFile}{wxtextfile} class which may be used to convert
	12	between different types of text files (DOS/Unix/Mac).
	13
	14	wxFile may be used for low-level IO. It contains all usual functions to work
	15	with files (opening/closing, reading/writing, seeking...) but, compared to
	16	using standard C functions, brings error checking (in case of an error a message
	17	is logged using \helpref{wxLog}{wxlog} facilities) and closes the file
	18	automatically in destructor which may be quite convenient.
	19
	20	wxTempFile is a very small file designed to make replacing the files contents
	21	safer - see its \helpref{documentation}{wxtempfile} for more details.
	22
	23	wxTextFile is a general purpose class for working with small text files on line
	24	by line basis. It is especially well suited for working with configuration files
	25	and program source files. It can be also used to work with files with "non
	26	native" line termination characters and write them as "native" files if needed
	27	(in fact, the files may be written in any format).