X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..394b206f07f1172e4523150736ecc0b152b7bcee:/docs/latex/wx/textfile.tex diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex index 5e37c98308..c139c6262a 100644 --- 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). -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: @@ -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. +\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 @@ -261,16 +262,16 @@ Insert a line before the line number {\it n}. \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 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} @@ -279,15 +280,21 @@ it is used to convert the file to wide character representation. 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{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 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.