X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..c29c95fe24973b94fd724db767193171ca7c513d:/interface/wx/sstream.h diff --git a/interface/wx/sstream.h b/interface/wx/sstream.h index 9fb340b705..609f19949b 100644 --- a/interface/wx/sstream.h +++ b/interface/wx/sstream.h @@ -3,15 +3,14 @@ // Purpose: interface of wxStringInputStream // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxStringInputStream - @wxheader{sstream.h} - This class implements an input stream which reads data from a string. It - supports seeking. + This class implements an input stream which reads data from a string. + It supports seeking. @library{wxbase} @category{streams} @@ -20,9 +19,11 @@ class wxStringInputStream : public wxInputStream { public: /** - Creates a new read-only stream using the specified string. Note that the string - is copied by the stream so if the original string is modified after using this - constructor, changes to it are not reflected when reading from stream. + Creates a new read-only stream using the specified string. + + Note that the string is copied by the stream so if the original string is + modified after using this constructor, changes to it are not reflected + when reading from stream. */ wxStringInputStream(const wxString& s); }; @@ -31,11 +32,12 @@ public: /** @class wxStringOutputStream - @wxheader{sstream.h} This class implements an output stream which writes data either to a - user-provided or internally allocated string. Note that currently this stream - does not support seeking but can tell its current position. + user-provided or internally allocated string. + + Note that currently this stream does not support seeking but can tell + its current position. @library{wxbase} @category{streams} @@ -52,17 +54,16 @@ public: If @a str is used, data written to the stream is appended to the current contents of it, i.e. the string is not cleared here. However if it is not - empty, the positions returned by wxOutputStream::TellO will be - offset by the initial string length, i.e. initial stream position will be the + empty, the positions returned by wxOutputStream::TellO will be offset by + the initial string length, i.e. initial stream position will be the initial length of the string and not 0. Notice that the life time of @a conv must be greater than the life time of this object itself as it stores a reference to it. Also notice that with default value of this argument the data written to the stream must - be valid UTF-8, pass @c wxConvISO8859_1 to deal with arbitrary 8 bit - data. + be valid UTF-8, pass @c wxConvISO8859_1 to deal with arbitrary 8 bit data. */ - wxStringOutputStream(wxString str = NULL, wxMBConv& conv = wxConvUTF8); + wxStringOutputStream(wxString* pString = 0, wxMBConv& conv = wxConvUTF8); /** Returns the string containing all the data written to the stream so far.