X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3ca6a5f04692678cd2d9f3ea0843fc3f5a0b254f..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/textfile.tex diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex index 7cd79b94a0..351eca9624 100644 --- a/docs/latex/wx/textfile.tex +++ b/docs/latex/wx/textfile.tex @@ -176,9 +176,11 @@ Returns TRUE if the current line is the last one. \constfunc{static const char*}{GetEOL}{\param{wxTextFileType }{type = typeDefault}} Get the line termination string corresponding to given constant. {\it typeDefault} is -the value defined during the compilation and corresponds to the native format of the -platform, i.e. it will be wxTextFileType\_Dos under Windows, wxTextFileType\_Unix under -Unix and wxTextFileType\_Mac under Mac. +the value defined during the compilation and corresponds to the native format +of the platform, i.e. it will be wxTextFileType\_Dos under Windows, +wxTextFileType\_Unix under Unix (including Mac OS X when compiling with the +Apple Developer Tools) and wxTextFileType\_Mac under Mac OS (including +Mac OS X when compiling with CodeWarrior). \membersection{wxTextFile::GetFirstLine}\label{wxtextfilegetfirstline} @@ -259,15 +261,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}} @@ -276,11 +281,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.