← Back to branch summary

~brian-sidebotham/wxwidgets-cmake/wxpython-2.9.4

« back to all changes in this revision

Viewing changes to docs/doxygen/overviews/file.h

  • Committer: Brian Sidebotham
  • Date: 2013-08-03 14:30:08 UTC
  • Revision ID: brian.sidebotham@gmail.com-20130803143008-c7806tkych1tp6fc
Initial import into Bazaar

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/doxygen/overviews/file.h
 
1
/////////////////////////////////////////////////////////////////////////////
 
2
// Name:        file.h
 
3
// Purpose:     topic overview
 
4
// Author:      wxWidgets team
 
5
// RCS-ID:      $Id: file.h 64940 2010-07-13 13:29:13Z VZ $
 
6
// Licence:     wxWindows licence
 
7
/////////////////////////////////////////////////////////////////////////////
 
8
 
 
9
/**
 
10
 
 
11
@page overview_file File Classes and Functions
 
12
 
 
13
Classes: wxFile, wxDir, wxTempFile,  wxTextFile
 
14
 
 
15
Functions: see @ref group_funcmacro_file.
 
16
 
 
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
 
19
example, the wxTextFile class which may be used to convert
 
20
between different types of text files (DOS/Unix/Mac).
 
21
 
 
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
 
25
is logged using wxLog facilities) and closes the file
 
26
automatically in the destructor which may be quite convenient.
 
27
 
 
28
wxTempFile is a very small file designed to make replacing the files contents
 
29
safer - see its documentation for more details.
 
30
 
 
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).
 
36
 
 
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.
 
40
 
 
41
*/
 
42