| 1 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 2 | %% Name: sostream.tex |
| 3 | %% Purpose: wxStringOutputStream docs |
| 4 | %% Author: Vadim Zeitlin |
| 5 | %% Modified by: |
| 6 | %% Created: 2004-09-19 |
| 7 | %% RCS-ID: $Id$ |
| 8 | %% Copyright: (c) 2004 Vadim Zeitlin |
| 9 | %% License: wxWindows licence |
| 10 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
| 11 | |
| 12 | \section{\class{wxStringOutputStream}}\label{wxstringoutputstream} |
| 13 | |
| 14 | This class implements an output stream which writes data either to a |
| 15 | user-provided or internally allocated string. Note that currently this stream |
| 16 | does not support seeking but can tell its current position. |
| 17 | |
| 18 | \wxheading{Derived from} |
| 19 | |
| 20 | \helpref{wxOutputStream}{wxoutputstream} |
| 21 | |
| 22 | \wxheading{Include files} |
| 23 | |
| 24 | <wx/sstream.h> |
| 25 | |
| 26 | |
| 27 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 28 | |
| 29 | \membersection{wxStringOutputStream::wxStringOutputStream}\label{wxstringoutputstreamctor} |
| 30 | |
| 31 | \func{}{wxStringOutputStream}{\param{wxString}{ *str = \texttt{NULL}}} |
| 32 | |
| 33 | If the provided pointer is non-\texttt{NULL}, data will be written to it. |
| 34 | Otherwise, an internal string is used for the data written to this stream, use |
| 35 | \helpref{GetString()}{wxstringoutputstreamgetstring} to get access to it. |
| 36 | |
| 37 | If \arg{str} is used, data written to the stream is appended to the current |
| 38 | contents of it, i.e. the string is not cleared here. However if it is not |
| 39 | empty, the positions returned by \helpref{TellO}{wxoutputstreamtello} will be |
| 40 | offset by the initial string length, i.e. initial stream position will be the |
| 41 | initial length of the string and not $0$. |
| 42 | |
| 43 | |
| 44 | \membersection{wxStringOutputStream::GetString}\label{wxstringoutputstreamgetstring} |
| 45 | |
| 46 | \constfunc{const wxString\&}{GetString}{\void} |
| 47 | |
| 48 | Returns the string containing all the data written to the stream so far. |
| 49 | |