]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/overviews/bufferclasses.h
don't defer showing if _NET_FRAME_EXTENTS handler is not connected
[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
9/*!
36c9828f 10
59c0db6a 11 @page overview_bufferclasses Buffer classes overview
36c9828f 12
15b6757b 13 wxWidgets uses two classes of classes for dealing with buffers in memory.
36c9828f 14
59c0db6a
FM
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.
36c9828f 18
59c0db6a
FM
19 Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer
20 for dealing with raw buffers in memory.
21
3b88355f 22 @li @ref overview_bufferclasses_xcb
59c0db6a
FM
23
24
25 <hr>
26
27
3b88355f
FM
28 @section overview_bufferclasses_xcb wxXCharBuffer Overview
29
30 @subsection overview_bufferclasses_xcb_general General Usage
36c9828f 31
59c0db6a
FM
32 As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal
33 with c strings in memory. They have two constructors, one in which you pass
34 the c string you want them to have a copy of, and another where you specify
35 the size of the buffer in memory in characters you want.
36c9828f 36
59c0db6a
FM
37 wxCharBuffer and its variant only contain the c string as a member, so they
38 can be used safely to c functions with variable arguments such as printf.
39 They also contain standard assignment, character access operators and a copy constructor.
40
3b88355f
FM
41 @subsection overview_bufferclasses_xcb_destruct Destruction
42
59c0db6a
FM
43 It should be noted that on destruction wxCharBuffer and its wide character
44 variant delete the c string that hold onto. If you want to get the pointer
45 to the buffer and don't want wxCharBuffer to delete it on destruction,
46 use the member function release to do so.
36c9828f 47
59c0db6a 48*/
36c9828f 49