projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 121fa06a VZ |
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 | |
| 8795498c | 9 | %% License: wxWindows licence |
| 121fa06a VZ |
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 | |
| a5ea75bc | 16 | does not support seeking but can tell its current position. |
| 121fa06a VZ |
17 | |
| 18 | \wxheading{Derived from} | |
| 19 | ||
| 20 | \helpref{wxOutputStream}{wxoutputstream} | |
| 21 | ||
| 22 | \wxheading{Include files} | |
| 23 | ||
| a08f2b59 | 24 | <wx/sstream.h> |
| 121fa06a | 25 | |
| a7af285d VZ |
26 | \wxheading{Library} |
| 27 | ||
| 28 | \helpref{wxBase}{librarieslist} | |
| 29 | ||
| 121fa06a VZ |
30 | |
| 31 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 32 | ||
| 08f1d438 | 33 | \membersection{wxStringOutputStream::wxStringOutputStream}\label{wxstringoutputstreamctor} |
| 121fa06a VZ |
34 | |
| 35 | \func{}{wxStringOutputStream}{\param{wxString}{ *str = \texttt{NULL}}} | |
| 36 | ||
| 37 | If the provided pointer is non-\texttt{NULL}, data will be written to it. | |
| 38 | Otherwise, an internal string is used for the data written to this stream, use | |
| 39 | \helpref{GetString()}{wxstringoutputstreamgetstring} to get access to it. | |
| 40 | ||
| a5ea75bc VZ |
41 | If \arg{str} is used, data written to the stream is appended to the current |
| 42 | contents of it, i.e. the string is not cleared here. However if it is not | |
| 43 | empty, the positions returned by \helpref{TellO}{wxoutputstreamtello} will be | |
| 44 | offset by the initial string length, i.e. initial stream position will be the | |
| 45 | initial length of the string and not $0$. | |
| 46 | ||
| 121fa06a VZ |
47 | |
| 48 | \membersection{wxStringOutputStream::GetString}\label{wxstringoutputstreamgetstring} | |
| 49 | ||
| 50 | \constfunc{const wxString\&}{GetString}{\void} | |
| 51 | ||
| 52 | Returns the string containing all the data written to the stream so far. | |
| 53 |