Unicodification of wxDataStreams

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@16246 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2002-07-21 22:29:08 +00:00
parent 55f9eba3b2
commit a99acbb00a
4 changed files with 70 additions and 12 deletions

View File

@@ -43,13 +43,20 @@ None
\func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}}
\func{}{wxDataInputStream}{\param{wxInputStream\&}{ stream}, \param{wxMBConv\&}{ conv = wxMBConvUTF8}}
Constructs a datastream object from an input stream. Only read methods will
be available.
be available. The second form is only available in Unicode build of wxWindows.
\wxheading{Parameters}
\docparam{stream}{The input stream.}
\docparam{conv}{Charset conversion object object used to decode strings in Unicode
mode (see \helpref{wxDataInputStream::ReadString}{wxdatainputstreamreadstring}
documentation for detailed description). Note that you must not destroy
{\it conv} before you destroy this wxDataInputStream instance!}
\membersection{wxDataInputStream::\destruct{wxDataInputStream}}
\func{}{\destruct{wxDataInputStream}}{\void}
@@ -89,12 +96,17 @@ Reads a 32 bit integer from the stream.
Reads a double (IEEE encoded) from the stream.
\membersection{wxDataInputStream::ReadString}
\membersection{wxDataInputStream::ReadString}\label{wxdatainputstreamreadstring}
\func{wxString}{ReadString}{\void}
Reads a string from a stream. Actually, this function first reads a long integer
specifying the length of the string (without the last null character) and then
reads the string.
Reads a string from a stream. Actually, this function first reads a long
integer specifying the length of the string (without the last null character)
and then reads the string.
In Unicode build of wxWindows, the fuction first reads multibyte (char*)
string from the stream and then converts it to Unicode using the {\it conv}
object passed to constructor and returns the result as wxString. You are
responsible for using the same convertor as when writing the stream.
See also \helpref{wxDataOutputStream::WriteString}{wxdataoutputstreamwritestring}.

View File

@@ -23,13 +23,22 @@ None
\func{}{wxDataOutputStream}{\param{wxOutputStream\&}{ stream}}
\func{}{wxDataOutputStream}{\param{wxOutputStream\&}{ stream}, \param{wxMBConv\&}{ conv = wxMBConvUTF8}}
Constructs a datastream object from an output stream. Only write methods will
be available.
be available. The second form is only available in Unicode build of wxWindows.
\wxheading{Parameters}
\docparam{stream}{The output stream.}
\docparam{conv}{Charset conversion object object used to encoding Unicode
strings before writing them to the stream
in Unicode mode (see \helpref{wxDataOutputStream::WriteString}{wxdataoutputstreamwritestring}
documentation for detailed description). Note that you must not destroy
{\it conv} before you destroy this wxDataOutputStream instance! It is
recommended to use default value (UTF-8).}
\membersection{wxDataOutputStream::\destruct{wxDataOutputStream}}
\func{}{\destruct{wxDataOutputStream}}{\void}
@@ -69,10 +78,17 @@ Writes the 32 bit integer {\it i32} to the stream.
Writes the double {\it f} to the stream using the IEEE format.
\membersection{wxDataOutputStream::WriteString}
\membersection{wxDataOutputStream::WriteString}\label{wxdataoutputstreamwritestring}
\func{void}{WriteString}{{\param const wxString\&}{string}}
\func{void}{WriteString}{{\param const wxString\& }{string}}
Writes {\it string} to the stream. Actually, this method writes the size of
the string before writing {\it string} itself.
In ANSI build of wxWindows, the string is written to the stream in exactly
same way it is represented in memory. In Unicode build, however, the string
is first converted to multibyte representation with {\it conv} object passed
to stream's constructor (consequently, ANSI application can read data
written by Unicode application, as long as they agree on encoding) and this
representation is written to the stream. UTF-8 is used by default.