]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/textfile.tex
corrected the example of wxMessageBox() usage
[wxWidgets.git] / docs / latex / wx / textfile.tex
index 002e5dd41da9234035dce3a60a752aa10119c0a2..05303637fe7c6b8ae3b2eff75e0e3a7e0298eac0 100644 (file)
@@ -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 
@@ -119,14 +120,14 @@ be used in this case.
 
 \constfunc{bool}{Exists}{\void}
 
 
 \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}
 
 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}
 
 
 \membersection{wxTextFile::GetLineCount}\label{wxtextfilegetlinecount}
 
@@ -169,7 +170,7 @@ and used by \helpref{GetFirstLine()}{wxtextfilegetfirstline}/\helpref{GetNextLin
 
 \constfunc{bool}{Eof}{\void}
 
 
 \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::GetEOL}\label{wxtextfilegeteol}
 
@@ -261,9 +262,9 @@ Insert a line before the line number {\it n}.
 
 \membersection{wxTextFile::Open}\label{wxtextfileopen}
 
 
 \membersection{wxTextFile::Open}\label{wxtextfileopen}
 
-\constfunc{bool}{Open}{\param{wxMBConv\&}{ conv = wxConvLibc}}
+\constfunc{bool}{Open}{\param{wxMBConv\&}{ conv = wxConvUTF8}}
 
 
-\constfunc{bool}{Open}{\param{const wxString\& }{strFile}, \param{wxMBConv\&}{ conv = wxConvLibc}}
+\constfunc{bool}{Open}{\param{const wxString\& }{strFile}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
 
 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
 
 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
@@ -279,9 +280,15 @@ 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}
 
 \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{wxMBConv\&}{ conv = wxConvUTF8}}
 
 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
 
 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
@@ -291,5 +298,5 @@ The {\it conv} argument is only meaningful in Unicode build of wxWindows 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.
 
-Returns TRUE if operation succeeded, FALSE if it failed.
+Returns true if operation succeeded, false if it failed.