updated wxTextFile docs; some typo corrections

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@11332 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex
index 0aa2ad24a3a33001f02a7f75186e37a4a821f587..fa8a9c8bdf216f404da2aaadf2acf95772d6bc3e 100644 (file)
--- a/docs/latex/wx/file.tex
+++ b/docs/latex/wx/file.tex
@@ -282,7 +282,7 @@ the number of bytes actually written
 
 Writes the contents of the string to the file, returns TRUE on success.
 
 
 Writes the contents of the string to the file, returns TRUE on success.
 

-The second argument specifies is only meaningful in Unicode build of wxWindows when
+The second argument is only meaningful in Unicode build of wxWindows when

 {\it conv} is used to convert {\it s} to multibyte representation.
 
 \section{\class{wxFFile}}\label{wxffile}
 {\it conv} is used to convert {\it s} to multibyte representation.
 
 \section{\class{wxFFile}}\label{wxffile}


@@ -483,5 +483,5 @@ Number of bytes written.
 
 Writes the contents of the string to the file, returns TRUE on success.
 
 
 Writes the contents of the string to the file, returns TRUE on success.
 

-The second argument specifies is only meaningful in Unicode build of wxWindows when
+The second argument is only meaningful in Unicode build of wxWindows when

 {\it conv} is used to convert {\it s} to multibyte representation.
 {\it conv} is used to convert {\it s} to multibyte representation.

diff --git a/docs/latex/wx/tempfile.tex b/docs/latex/wx/tempfile.tex
index 6263e615a5a46cdae37c8d40b6027f35ba98d72a..01a31ffdb293f79d562bd2826a79ef548d3bff69 100644 (file)
--- a/docs/latex/wx/tempfile.tex
+++ b/docs/latex/wx/tempfile.tex
@@ -85,7 +85,7 @@ Write to the file, return TRUE on success, FALSE on failure.
 
 Write to the file, return TRUE on success, FALSE on failure.
 
 
 Write to the file, return TRUE on success, FALSE on failure.
 

-The second argument specifies is only meaningful in Unicode build of wxWindows when
+The second argument is only meaningful in Unicode build of wxWindows when

 {\it conv} is used to convert {\it str} to multibyte representation.
 
 \membersection{wxTempFile::Commit}\label{wxtempfilecommit}
 {\it conv} is used to convert {\it str} to multibyte representation.
 
 \membersection{wxTempFile::Commit}\label{wxtempfilecommit}

diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex
index 7cd79b94a0c2e887753bf46ddbdbef99632c9a0f..1497bd83c2ba1146faf7960d4bfff51b8041faee 100644 (file)
--- a/docs/latex/wx/textfile.tex
+++ b/docs/latex/wx/textfile.tex
@@ -259,15 +259,18 @@ Insert a line before the line number {\it n}.
 
 \membersection{wxTextFile::Open}\label{wxtextfileopen}
 
 
 \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.
 
 
 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}}
 \membersection{wxTextFile::RemoveLine}\label{wxtextfileremoveline}
 
 \constfunc{void}{RemoveLine}{\param{size\_t }{n}}


@@ -276,11 +279,15 @@ Delete line number {\it n} from the file.
 
 \membersection{wxTextFile::Write}\label{wxtextfilewrite}
 
 
 \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.
 
 
 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.
 
 Returns TRUE if operation succeeded, FALSE if it failed.