X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/15d83f726c215b06f2fdd15ece40d66d2f16a01d..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/txtstrm.tex?ds=sidebyside diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex index c739fe4529..3a6a48f350 100644 --- a/docs/latex/wx/txtstrm.tex +++ b/docs/latex/wx/txtstrm.tex @@ -39,12 +39,17 @@ For example: +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxTextInputStream::wxTextInputStream}\label{wxtextinputstreamctor} \func{}{wxTextInputStream}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ sep=" $\backslash$t"}, - \param{wxMBConv\&}{ conv = wxConvUTF8} } + \param{const wxMBConv\&}{ conv = wxConvAuto()} } Constructs a text stream associated to the given input stream. @@ -57,12 +62,14 @@ Constructs a text stream associated to the given input stream. \docparam{conv}{{\it In Unicode build only:} The encoding converter used to convert the bytes in the underlying input stream to characters.} + \membersection{wxTextInputStream::\destruct{wxTextInputStream}}\label{wxtextinputstreamdtor} \func{}{\destruct{wxTextInputStream}}{\void} Destroys the wxTextInputStream object. + \membersection{wxTextInputStream::Read8}\label{wxtextinputstreamread8} \func{wxUint8}{Read8}{\param{int}{ base = 10}} @@ -77,6 +84,7 @@ that you may not want to specify the base $0$ if you are parsing the numbers which may have leading zeroes as they can yield unexpected (to the user not familiar with C) results. + \membersection{wxTextInputStream::Read8S}\label{wxtextinputstreamread8s} \func{wxInt8}{Read8S}{\param{int}{ base = 10}} @@ -86,6 +94,7 @@ Reads a single signed byte from the stream. See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the description of the {\it base} parameter. + \membersection{wxTextInputStream::Read16}\label{wxtextinputstreamread16} \func{wxUint16}{Read16}{\param{int}{ base = 10}} @@ -95,6 +104,7 @@ Reads a unsigned 16 bit integer from the stream. See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the description of the {\it base} parameter. + \membersection{wxTextInputStream::Read16S}\label{wxtextinputstreamread16s} \func{wxInt16}{Read16S}{\param{int}{ base = 10}} @@ -104,6 +114,7 @@ Reads a signed 16 bit integer from the stream. See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the description of the {\it base} parameter. + \membersection{wxTextInputStream::Read32}\label{wxtextinputstreamread32} \func{wxUint32}{Read32}{\param{int}{ base = 10}} @@ -113,6 +124,7 @@ Reads a 32 bit unsigned integer from the stream. See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the description of the {\it base} parameter. + \membersection{wxTextInputStream::Read32S}\label{wxtextinputstreamread32s} \func{wxInt32}{Read32S}{\param{int}{ base = 10}} @@ -122,37 +134,42 @@ Reads a 32 bit signed integer from the stream. See \helpref{wxTextInputStream::Read8}{wxtextinputstreamread8} for the description of the {\it base} parameter. -\membersection{wxTextInputStream::ReadChar}\label{wxtextinputstreamreadchar} -\func{wxChar}{wxTextInputStream::ReadChar}{\void} +\membersection{wxTextInputStream::GetChar}\label{wxtextinputstreamgetchar} + +\func{wxChar}{GetChar}{\void} Reads a character, returns $0$ if there are no more characters in the stream. + \membersection{wxTextInputStream::ReadDouble}\label{wxtextinputstreamreaddouble} \func{double}{ReadDouble}{\void} Reads a double (IEEE encoded) from the stream. + \membersection{wxTextInputStream::ReadLine}\label{wxtextinputstreamreadline} -\func{wxString}{wxTextInputStream::ReadLine}{\void} +\func{wxString}{ReadLine}{\void} Reads a line from the input stream and returns it (without the end of line character). + \membersection{wxTextInputStream::ReadString}\label{wxtextinputstreamreadstring} -\func{wxString}{wxTextInputStream::ReadString}{\void} +\func{wxString}{ReadString}{\void} {\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} +\func{wxString}{ReadWord}{\void} Reads a word (a sequence of characters until the next separator) from the input stream. @@ -161,6 +178,7 @@ input stream. \helpref{SetStringSeparators}{wxtextinputstreamsetstringseparators} + \membersection{wxTextInputStream::SetStringSeparators}\label{wxtextinputstreamsetstringseparators} \func{void}{SetStringSeparators}{\param{const wxString\& }{sep}} @@ -193,11 +211,20 @@ You can also simulate the C++ cout class: The wxTextOutputStream writes text files (or streams) on DOS, Macintosh and Unix in their native formats (concerning the line ending). +\wxheading{Include files} + + + +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxTextOutputStream::wxTextOutputStream}\label{wxtextoutputstreamctor} -\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}, \param{wxMBConv\&}{ conv = wxConvUTF8}} +\func{}{wxTextOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxEOL}{ mode = wxEOL\_NATIVE}, \param{const wxMBConv\&}{ conv = wxConvAuto()}} Constructs a text stream object associated to the given output stream. @@ -210,51 +237,66 @@ Constructs a text stream object associated to the given output stream. \docparam{conv}{{\it In Unicode build only:} The object used to convert Unicode text into ASCII characters written to the output stream.} + \membersection{wxTextOutputStream::\destruct{wxTextOutputStream}}\label{wxtextoutputstreamdtor} \func{}{\destruct{wxTextOutputStream}}{\void} Destroys the wxTextOutputStream object. + \membersection{wxTextOutputStream::GetMode}\label{wxtextoutputstreamgetmode} -\func{wxEOL}{wxTextOutputStream::GetMode}{\void} +\func{wxEOL}{GetMode}{\void} Returns the end-of-line mode. One of {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}. + +\membersection{wxTextOutputStream::PutChar}\label{wxtextoutputstreamputchar} + +\func{void}{PutChar}{{\param wxChar }{c}} + +Writes a character to the stream. + + \membersection{wxTextOutputStream::SetMode}\label{wxtextoutputstreamsetmode} -\func{void}{wxTextOutputStream::SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}} +\func{void}{SetMode}{{\param wxEOL}{ mode = wxEOL\_NATIVE}} Set the end-of-line mode. One of {\bf wxEOL\_NATIVE}, {\bf wxEOL\_DOS}, {\bf wxEOL\_MAC} and {\bf wxEOL\_UNIX}. + \membersection{wxTextOutputStream::Write8}\label{wxtextoutputstreamwrite8} -\func{void}{wxTextOutputStream::Write8}{{\param wxUint8 }{i8}} +\func{void}{Write8}{{\param wxUint8 }{i8}} Writes the single byte {\it i8} to the stream. + \membersection{wxTextOutputStream::Write16}\label{wxtextoutputstreamwrite16} -\func{void}{wxTextOutputStream::Write16}{{\param wxUint16 }{i16}} +\func{void}{Write16}{{\param wxUint16 }{i16}} Writes the 16 bit integer {\it i16} to the stream. + \membersection{wxTextOutputStream::Write32}\label{wxtextoutputstreamwrite32} -\func{void}{wxTextOutputStream::Write32}{{\param wxUint32 }{i32}} +\func{void}{Write32}{{\param wxUint32 }{i32}} Writes the 32 bit integer {\it i32} to the stream. + \membersection{wxTextOutputStream::WriteDouble}\label{wxtextoutputstreamwritedouble} -\func{virtual void}{wxTextOutputStream::WriteDouble}{{\param double }{f}} +\func{virtual void}{WriteDouble}{{\param double }{f}} Writes the double {\it f} to the stream using the IEEE format. + \membersection{wxTextOutputStream::WriteString}\label{wxtextoutputstreamwritestring} -\func{virtual void}{wxTextOutputStream::WriteString}{{\param const wxString\& }{string}} +\func{virtual void}{WriteString}{{\param const wxString\& }{string}} Writes {\it string} as a line. Depending on the end-of-line mode the end of line ('$\backslash$n') characters in the string are converted to the correct