]>
git.saurik.com Git - wxWidgets.git/blob - docs/doxygen/overviews/bufferclasses.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: bufferclasses.h
3 // Purpose: topic overview
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
11 @page overview_bufferclasses Buffer classes overview
13 wxWidgets uses two classes of classes for dealing with buffers in memory.
15 The first is one for dealing with character buffers, namely wxCharBuffer
16 for char pointer or multi-byte c strings and wxWCharBuffer for wchar_t pointer
17 or wide character c strings.
19 Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer
20 for dealing with raw buffers in memory.
22 @li @ref overview_bufferclasses_wxcb
28 @section overview_bufferclasses_wxcb wxXCharBuffer Overview
31 As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal
32 with c strings in memory. They have two constructors, one in which you pass
33 the c string you want them to have a copy of, and another where you specify
34 the size of the buffer in memory in characters you want.
36 wxCharBuffer and its variant only contain the c string as a member, so they
37 can be used safely to c functions with variable arguments such as printf.
38 They also contain standard assignment, character access operators and a copy constructor.
41 It should be noted that on destruction wxCharBuffer and its wide character
42 variant delete the c string that hold onto. If you want to get the pointer
43 to the buffer and don't want wxCharBuffer to delete it on destruction,
44 use the member function release to do so.