X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/605d715ddd84ddc3e78423e3f3ae5c27c8ff4d43..f6ed38239c20927281363f3828323e05b4917c0e:/docs/latex/wx/txtstrm.tex?ds=inline diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex index 06a37e88bc..08217a6d98 100644 --- a/docs/latex/wx/txtstrm.tex +++ b/docs/latex/wx/txtstrm.tex @@ -13,9 +13,10 @@ Operator >> is overloaded and you can use this class like a standard C++ iostrea Note, however, that the arguments are the fixed size types wxUint32, wxInt32 etc and on a typical 32-bit computer, none of these match to the "long" type (wxInt32 is defined as int on 32-bit architectures) so that you cannot use long. To avoid -problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types. +problems (here and elsewhere), make use of wxInt32, wxUint32 and similar types. For example: + \begin{verbatim} wxFileInputStream input( "mytext.txt" ); wxTextInputStream text( input ); @@ -75,12 +76,41 @@ Reads a 32 bit integer from the stream. Reads a double (IEEE encoded) from the stream. +\membersection{wxTextInputStream::ReadLine}\label{wxtextinputstreamreadline} + +\func{wxString}{wxTextInputStream::ReadLine}{\void} + +Reads a line from the input stream and returns it (without the end of line +character). + \membersection{wxTextInputStream::ReadString} \func{wxString}{wxTextInputStream::ReadString}{\void} -Reads a line from the stream. A line is a string which ends with -$\backslash$n or $\backslash$r$\backslash$n or $\backslash$r. +{\bf NB:} This method is deprecated, use \helpref{ReadLine}{wxtextinputstreamreadline} +or \helpref{ReadWord}{wxtextinputstreamreadword} instead. + +Same as \helpref{ReadLine}{wxtextinputstreamreadline}. + +\membersection{wxTextInputStream::ReadWord}\label{wxtextinputstreamreadword} + +\func{wxString}{wxTextInputStream::ReadWord}{\void} + +Reads a word (a sequence of characters until the next separator) from the +input stream. + +\wxheading{See also} + +\helpref{SetStringSeparators}{wxtextinputstreamsetstringseparators} + +\membersection{wxTextInputStream::SetStringSeparators}\label{wxtextinputstreamsetstringseparators} + +\func{void}{SetStringSeparators}{\param{const wxString\& }{sep}} + +Sets the characters which are used to define the word boundaries in +\helpref{ReadWord}{wxtextinputstreamreadword}. + +The default separators are the space and {\tt TAB} characters. % ---------------------------------------------------------------------------- % wxTextOutputStream @@ -92,6 +122,7 @@ This class provides functions that write text datas using an output stream. So, you can write {\it text} floats, integers. You can also simulate the C++ cout class: + \begin{verbatim} wxFFileOutputStream output( stderr ); wxTextOutputStream cout( output ); @@ -117,7 +148,7 @@ be available. \docparam{stream}{The output stream.} -\docparam{mode}{The end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}.} +\docparam{mode}{The end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}.} \membersection{wxTextOutputStream::\destruct{wxTextOutputStream}} @@ -129,13 +160,13 @@ Destroys the wxTextOutputStream object. \func{wxEOL}{wxTextOutputStream::GetMode}{\void} -Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}. +Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}. \membersection{wxTextOutputStream::SetMode} \func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}} -Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} or {\bf wxEOL\_UNIX}. +Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}. \membersection{wxTextOutputStream::Write8} @@ -165,6 +196,6 @@ Writes the double {\it f} to the stream using the IEEE format. \func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}} -Writes {\it string} as a line. Depending on the end-of-line mode, it adds +Writes {\it string} as a line. Depending on the end-of-line mode, it adds $\backslash$n, $\backslash$r or $\backslash$r$\backslash$n.