added HTML printing

[wxWidgets.git] / docs / latex / wx / textfile.tex

diff --git a/docs/latex/wx/textfile.tex b/docs/latex/wx/textfile.tex
index 713b05bab98bb9c529b3cd98caa0db1a841cb954..275479dab3b992470e22c863eff9c5c16641411d 100644 (file)
--- a/docs/latex/wx/textfile.tex
+++ b/docs/latex/wx/textfile.tex
@@ -1,11 +1,10 @@
-% automatically generated by HelpGen from textfile.tex at 10/Jan/99 18:47:37

 \section{\class{wxTextFile}}\label{wxtextfile}
 
 The wxTextFile is a simple class which allows to work with text files on line by
 line basis. It also understands the differences in line termination characters
 under different platforms and will not do anything bad to files with "non
 native" line termination sequences - in fact, it can be also used to modify the
 \section{\class{wxTextFile}}\label{wxtextfile}
 
 The wxTextFile is a simple class which allows to work with text files on line by
 line basis. It also understands the differences in line termination characters
 under different platforms and will not do anything bad to files with "non
 native" line termination sequences - in fact, it can be also used to modify the

-text files and chaneg the line termination characters from one type (say DOS) to
+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
 another (say Unix).
 
 One word of warning: the class is not at all optimized for big files and so it


@@ -23,7 +22,7 @@ function which opens the file (name may be specified either as Open argument or
 in the constructor), reads its contents in memory and closes it. If all of these
 operations are successful, Open() will return TRUE and FALSE on error.
 \item Work with the lines in the file: this may be done either with "direct
 in the constructor), reads its contents in memory and closes it. If all of these
 operations are successful, Open() will return TRUE and FALSE on error.
 \item Work with the lines in the file: this may be done either with "direct

-access" functions like \helpref{GetLineCount}{wxtextfilegetlinecount} and
+access" functions like \helpref{GetLineCount}{wxtextfilegetlinecount} and 

 \helpref{GetLine}{wxtextfilegetline} ({\it operator[]} does exactly the same
 but looks more like array addressing) or with "sequential access" functions
 which include \helpref{GetFirstLine}{wxtextfilegetfirstline}/
 \helpref{GetLine}{wxtextfilegetline} ({\it operator[]} does exactly the same
 but looks more like array addressing) or with "sequential access" functions
 which include \helpref{GetFirstLine}{wxtextfilegetfirstline}/


@@ -35,21 +34,21 @@ 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.

-\item Save your changes: notice that the changes you do to the file will {\bf
-not} be saved automatically, calling \helpref{Close}{wxtextfileclose} or doing
-nothing discards them! To save the chanegs 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 

 \helpref{Write}{wxtextfilewrite} - here, you may also change the line
 termination type if you wish.
 \end{itemize}
 
 \helpref{Write}{wxtextfilewrite} - here, you may also change the line
 termination type if you wish.
 \end{itemize}
 

-\wxheading{See also:}
-
-\helpref{wxFile}{wxfile}
-

 \wxheading{Derived from}
 
 No base class
 
 \wxheading{Derived from}
 
 No base class
 

+\wxheading{Include files}
+
+<wx/textfile.h>
+

 \wxheading{Data structures}
 
 The following constants identify the line termination type:
 \wxheading{Data structures}
 
 The following constants identify the line termination type:


@@ -60,12 +59,17 @@ enum wxTextFileType
     wxTextFileType_Unix,  // line is terminated with 'LF' = 0xA = 10 = '\n'
     wxTextFileType_Dos,   //                         'CR' 'LF'
     wxTextFileType_Mac    //                         'CR' = 0xD = 13 = '\r'
     wxTextFileType_Unix,  // line is terminated with 'LF' = 0xA = 10 = '\n'
     wxTextFileType_Dos,   //                         'CR' 'LF'
     wxTextFileType_Mac    //                         'CR' = 0xD = 13 = '\r'

-}
+};

 \end{verbatim}
 
 \end{verbatim}
 

+\wxheading{See also}
+
+\helpref{wxFile}{wxfile}
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxTextFile::wxTextFile}\label{wxtextfilectordef}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxTextFile::wxTextFile}\label{wxtextfilectordef}

+

 \constfunc{}{wxTextFile}{\void}
 
 Default constructor, use Open(string) to initialize the object.
 \constfunc{}{wxTextFile}{\void}
 
 Default constructor, use Open(string) to initialize the object.


@@ -145,7 +149,7 @@ GoToLine().
 \constfunc{void}{GoToLine}{\param{size\_t }{n}}
 
 Changes the value returned by \helpref{GetCurrentLine}{wxtextfilegetcurrentline} 
 \constfunc{void}{GoToLine}{\param{size\_t }{n}}
 
 Changes the value returned by \helpref{GetCurrentLine}{wxtextfilegetcurrentline} 

-and used by \helpref{GetFirstLine()}{wxtextfilegetfirstline}()/\helpref{GetNextLine()}{wxtextfilegetnextline}.
+and used by \helpref{GetFirstLine()}{wxtextfilegetfirstline}/\helpref{GetNextLine()}{wxtextfilegetnextline}.

 
 \membersection{wxTextFile::Eof}\label{wxtextfileeof}
 
 
 \membersection{wxTextFile::Eof}\label{wxtextfileeof}
 


@@ -223,16 +227,18 @@ Insert a line before the line number {\it n}.
 
 \constfunc{void}{RemoveLine}{\param{size\_t }{n}}
 
 
 \constfunc{void}{RemoveLine}{\param{size\_t }{n}}
 

-Delete one line from the file.
+Delete line number {\it n} from the file.

 
 \membersection{wxTextFile::Write}\label{wxtextfilewrite}
 
 \constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}}
 
 
 \membersection{wxTextFile::Write}\label{wxtextfilewrite}
 
 \constfunc{bool}{Write}{\param{wxTextFileType }{typeNew = wxTextFileType\_None}}
 

-Change the file on disk. The {\it typeNew} parameter allows to change the
+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.
 
 file format (default argument means "don't change type") and may be used to
 convert, for example, DOS files to Unix.
 

+Returns TRUE if operation succeeded, FALSE if it failed.
+

 \membersection{wxTextFile::GetEOL}\label{wxtextfilegeteol}
 
 \constfunc{static const char*}{GetEOL}{\param{wxTextFileType }{type = typeDefault}}
 \membersection{wxTextFile::GetEOL}\label{wxtextfilegeteol}
 
 \constfunc{static const char*}{GetEOL}{\param{wxTextFileType }{type = typeDefault}}