]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/overviews/bufferclasses.h
removed wxAcceleratorTable copy ctor docs, no port implements it
[wxWidgets.git] / docs / doxygen / overviews / bufferclasses.h
CommitLineData
15b6757b 1/////////////////////////////////////////////////////////////////////////////
59c0db6a 2// Name: bufferclasses.h
15b6757b
FM
3// Purpose: topic overview
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
880efa2a 9/**
36c9828f 10
880efa2a 11@page overview_bufferclasses Buffer Classes
36c9828f 12
880efa2a 13wxWidgets uses two classes of classes for dealing with buffers in memory.
36c9828f 14
880efa2a
BP
15The first is one for dealing with character buffers, namely wxCharBuffer for
16char pointer or multi-byte c strings and wxWCharBuffer for wchar_t pointer or
17wide character c strings.
36c9828f 18
880efa2a
BP
19Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer for
20dealing with raw buffers in memory.
59c0db6a 21
880efa2a 22@li @ref overview_bufferclasses_xcb
59c0db6a
FM
23
24
880efa2a 25<hr>
59c0db6a
FM
26
27
880efa2a 28@section overview_bufferclasses_xcb wxXCharBuffer
3b88355f 29
880efa2a 30@subsection overview_bufferclasses_xcb_general General Usage
36c9828f 31
880efa2a
BP
32As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal
33with c strings in memory. They have two constructors, one in which you pass
34the c string you want them to have a copy of, and another where you specify the
35size of the buffer in memory in characters you want.
36c9828f 36
880efa2a
BP
37wxCharBuffer and its variant only contain the c string as a member, so they can
38be used safely to c functions with variable arguments such as printf. They also
39contain standard assignment, character access operators and a copy constructor.
59c0db6a 40
880efa2a 41@subsection overview_bufferclasses_xcb_destruct Destruction
3b88355f 42
880efa2a
BP
43It should be noted that on destruction wxCharBuffer and its wide character
44variant delete the c string that hold onto. If you want to get the pointer to
45the buffer and don't want wxCharBuffer to delete it on destruction, use the
46member function release to do so.
36c9828f 47
59c0db6a 48*/
36c9828f 49