git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: sstream.h
	3	// Purpose: interface of wxStringInputStream
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxStringInputStream
	11
	12	This class implements an input stream which reads data from a string. It
	13	supports seeking.
	14
	15	@library{wxbase}
	16	@category{streams}
	17	*/
	18	class wxStringInputStream : public wxInputStream
	19	{
	20	public:
	21	/**
	22	Creates a new read-only stream using the specified string. Note that the string
	23	is copied by the stream so if the original string is modified after using this
	24	constructor, changes to it are not reflected when reading from stream.
	25	*/
	26	wxStringInputStream(const wxString& s);
	27	};
	28
	29
	30
	31	/**
	32	@class wxStringOutputStream
	33
	34	This class implements an output stream which writes data either to a
	35	user-provided or internally allocated string. Note that currently this stream
	36	does not support seeking but can tell its current position.
	37
	38	@library{wxbase}
	39	@category{streams}
	40	*/
	41	class wxStringOutputStream : public wxOutputStream
	42	{
	43	public:
	44	/**
	45	Construct a new stream object writing the data to a string.
	46
	47	If the provided pointer is non-@NULL, data will be written to it.
	48	Otherwise, an internal string is used for the data written to this
	49	stream, use GetString() to get access to it.
	50
	51	If @a str is used, data written to the stream is appended to the current
	52	contents of it, i.e. the string is not cleared here. However if it is not
	53	empty, the positions returned by wxOutputStream::TellO will be
	54	offset by the initial string length, i.e. initial stream position will be the
	55	initial length of the string and not 0.
	56
	57	Notice that the life time of @a conv must be greater than the life time
	58	of this object itself as it stores a reference to it. Also notice that
	59	with default value of this argument the data written to the stream must
	60	be valid UTF-8, pass @c wxConvISO8859_1 to deal with arbitrary 8 bit
	61	data.
	62	*/
	63	wxStringOutputStream(wxString str = NULL, wxMBConv& conv = wxConvUTF8);
	64
	65	/**
	66	Returns the string containing all the data written to the stream so far.
	67	*/
	68	const wxString& GetString() const;
	69	};
	70