X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..16d38102e8ad5534d185cc532b9aa8077a75e0a4:/docs/latex/wx/textfile.tex diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex index ff7ecc856f..1497bd83c2 100644 --- a/docs/latex/wx/textfile.tex +++ b/docs/latex/wx/textfile.tex @@ -189,10 +189,13 @@ allows more "iterator-like" traversal of the list of lines, i.e. you may write something like: \begin{verbatim} -for ( str = GetFirstLine(); !Eof(); str = GetNextLine() ) +wxTextFile file; +... +for ( str = file.GetFirstLine(); !file.Eof(); str = file.GetNextLine() ) { // do something with the current line in str } +// do something with the last line in str \end{verbatim} \membersection{wxTextFile::GetNextLine}\label{wxtextfilegetnextline} @@ -212,7 +215,21 @@ Gets the previous line in the file. \func{wxString\&}{GetLastLine}{\void} -Gets the last line of the file. +Gets the last line of the file. Together with +\helpref{GetPrevLine}{wxtextfilegetprevline} it allows to enumerate the lines +in the file from the end to the beginning like this: + +\begin{verbatim} +wxTextFile file; +... +for ( str = file.GetLastLine(); + file.GetCurrentLine() > 0; + str = file.GetPrevLine() ) +{ + // do something with the current line in str +} +// do something with the first line in str +\end{verbatim} \membersection{wxTextFile::GetLineType}\label{wxtextfilegetlinetype} @@ -242,15 +259,18 @@ Insert a line before the line number {\it n}. \membersection{wxTextFile::Open}\label{wxtextfileopen} -\constfunc{bool}{Open}{\void} +\constfunc{bool}{Open}{\param{wxMBConv&}{ conv = wxConvLibc}} -\constfunc{bool}{Open}{\param{const wxString\& }{strFile}} +\constfunc{bool}{Open}{\param{const wxString\& }{strFile}, \param{wxMBConv&}{ conv = wxConvLibc}} 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 +it is used to convert the file to wide character representation. + \membersection{wxTextFile::RemoveLine}\label{wxtextfileremoveline} \constfunc{void}{RemoveLine}{\param{size\_t }{n}} @@ -259,11 +279,15 @@ Delete line number {\it n} from the file. \membersection{wxTextFile::Write}\label{wxtextfilewrite} -\constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}} +\constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}, \param{wxMBConv&}{ conv = wxConvLibc}} 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 +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.