text files and change the line termination characters from one type (say DOS) to
another (say Unix).
-One word of warning: the class is not at all optimized for big files and so it
-will load the file entirely into memory when opened. Of course, you should not
+One word of warning: the class is not at all optimized for big files and thus
+it will load the file entirely into memory when opened. Of course, you should not
work in this way with large files (as an estimation, anything over 1 Megabyte is
surely too big for this class). On the other hand, it is not a serious
-limitation for the small files like configuration files or programs sources
+limitation for small files like configuration files or program sources
which are well handled by wxTextFile.
The typical things you may do with wxTextFile in order are:
\item Add/remove lines to the file: \helpref{AddLine}{wxtextfileaddline} and
\helpref{InsertLine}{wxtextfileinsertline} add new lines while
\helpref{RemoveLine}{wxtextfileremoveline} deletes the existing ones.
+\helpref{Clear}{wxtextfileclear} resets the file to empty.
\item Save your changes: notice that the changes you make to the file will {\bf
not} be saved automatically; calling \helpref{Close}{wxtextfileclose} or doing
nothing discards them! To save the changes you must explicitly call
\constfunc{bool}{Exists}{\void}
-Return TRUE if file exists - the name of the file should have been specified
+Return true if file exists - the name of the file should have been specified
in the constructor before calling Exists().
\membersection{wxTextFile::IsOpened}\label{wxtextfileisopened}
\constfunc{bool}{IsOpened}{\void}
-Returns TRUE if the file is currently opened.
+Returns true if the file is currently opened.
\membersection{wxTextFile::GetLineCount}\label{wxtextfilegetlinecount}
\constfunc{bool}{Eof}{\void}
-Returns TRUE if the current line is the last one.
+Returns true if the current line is the last one.
\membersection{wxTextFile::GetEOL}\label{wxtextfilegeteol}
\membersection{wxTextFile::Open}\label{wxtextfileopen}
-\constfunc{bool}{Open}{\param{wxMBConv\&}{ conv = wxConvLibc}}
+\constfunc{bool}{Open}{\param{const wxMBConv\&}{ conv = wxConvAuto()}}
-\constfunc{bool}{Open}{\param{const wxString\& }{strFile}, \param{wxMBConv\&}{ conv = wxConvLibc}}
+\constfunc{bool}{Open}{\param{const wxString\& }{strFile}, \param{const wxMBConv\&}{ conv = wxConvAuto()}}
Open() opens the file with the given name or the name which was given in the
\helpref{constructor}{wxtextfilector} and also loads file in memory on
success. It will fail if the file does not exist,
\helpref{Create}{wxtextfilecreate} should be used in this case.
-The {\it conv} argument is only meaningful in Unicode build of wxWindows when
+The {\it conv} argument is only meaningful in Unicode build of wxWidgets when
it is used to convert the file to wide character representation.
\membersection{wxTextFile::RemoveLine}\label{wxtextfileremoveline}
Delete line number {\it n} from the file.
+\membersection{wxTextFile::Clear}\label{wxtextfileclear}
+
+\constfunc{void}{Clear}{\void}
+
+Delete all lines from the file, set current line number to 0.
+
\membersection{wxTextFile::Write}\label{wxtextfilewrite}
-\constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}, \param{wxMBConv\&}{ conv = wxConvLibc}}
+\constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}, \param{const wxMBConv\&}{ conv = wxConvAuto()}}
Change the file on disk. The {\it typeNew} parameter allows you to change the
file format (default argument means "don't change type") and may be used to
convert, for example, DOS files to Unix.
-The {\it conv} argument is only meaningful in Unicode build of wxWindows when
+The {\it conv} argument is only meaningful in Unicode build of wxWidgets when
it is used to convert all lines to multibyte representation before writing them
them to physical file.
-Returns TRUE if operation succeeded, FALSE if it failed.
+Returns true if operation succeeded, false if it failed.