define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

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

diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex
index 37cb4bf8821c708c69f28c0691a35e7e7acfec22..c139c6262afb1066f2e05dcdeb715bbc2b268341 100644 (file)
--- a/docs/latex/wx/textfile.tex
+++ b/docs/latex/wx/textfile.tex
@@ -7,11 +7,11 @@ native" line termination sequences - in fact, it can be also used to modify the
 text files and change the line termination characters from one type (say DOS) to
 another (say Unix).
 
 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
 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:
 which are well handled by wxTextFile.
 
 The typical things you may do with wxTextFile in order are:


@@ -35,6 +35,7 @@ changed with \helpref{GoToLine}{wxtextfilegotoline}.
 \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.
 \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 
 \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 


@@ -270,7 +271,7 @@ Open() opens the file with the given name or the name which was given in the
 success. It will fail if the file does not exist, 
 \helpref{Create}{wxtextfilecreate} should be used in this case.
 
 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}
 it is used to convert the file to wide character representation.
 
 \membersection{wxTextFile::RemoveLine}\label{wxtextfileremoveline}


@@ -279,6 +280,12 @@ it is used to convert the file to wide character representation.
 
 Delete line number {\it n} from the file.
 
 
 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 = wxConvUTF8}}
 \membersection{wxTextFile::Write}\label{wxtextfilewrite}
 
 \constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}, \param{wxMBConv\&}{ conv = wxConvUTF8}}


@@ -287,7 +294,7 @@ 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.
 
 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.
 
 it is used to convert all lines to multibyte representation before writing them
 them to physical file.