[wxWidgets.git] / docs / doxygen / overviews / bufferclasses.h

/////////////////////////////////////////////////////////////////////////////
// Name:        bufferclasses
// Purpose:     topic overview
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/*!

 @page bufferclasses_overview Buffer classes overview

 wxWidgets uses two classes of classes for dealing with buffers in memory.
 The first is one for dealing with character buffers, namely wxCharBuffer for char pointer or multi-byte c strings and wxWCharBuffer for wchar_t pointer or wide character c strings.
 Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer for dealing with raw buffers in memory.
 @ref cbov_overview


 @section wxcbov wxXCharBuffer Overview

 @b General Usage
 As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal with c strings in memory.  They have two constructors, one in which you pass the c string you want them to have a copy of, and another where you specify the size of the buffer in memory in characters you want.
 wxCharBuffer and its variant only contain the c string as a member, so they can be used safely to c functions with variable arguments such as printf.  They also contain standard assignment, character access operators and a copy constructor.
 @b Destruction
 It should be noted that on destruction wxCharBuffer and its wide character variant delete the c string that hold onto.  If you want to get the pointer to the buffer and don't want wxCharBuffer to delete it on destruction, use the member function release to do so.

 */
Commit	Line	Data
15b6757b FM	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: bufferclasses
	3	// Purpose: topic overview
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/*!
36c9828f	10
15b6757b	11	@page bufferclasses_overview Buffer classes overview
36c9828f	12
15b6757b FM	13	wxWidgets uses two classes of classes for dealing with buffers in memory.
	14	The first is one for dealing with character buffers, namely wxCharBuffer for char pointer or multi-byte c strings and wxWCharBuffer for wchar_t pointer or wide character c strings.
	15	Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer for dealing with raw buffers in memory.
	16	@ref cbov_overview
36c9828f FM	17
36c9828f FM	18
15b6757b	19	@section wxcbov wxXCharBuffer Overview
36c9828f	20
15b6757b FM	21	@b General Usage
	22	As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal with c strings in memory. They have two constructors, one in which you pass the c string you want them to have a copy of, and another where you specify the size of the buffer in memory in characters you want.
	23	wxCharBuffer and its variant only contain the c string as a member, so they can be used safely to c functions with variable arguments such as printf. They also contain standard assignment, character access operators and a copy constructor.
	24	@b Destruction
	25	It should be noted that on destruction wxCharBuffer and its wide character variant delete the c string that hold onto. If you want to get the pointer to the buffer and don't want wxCharBuffer to delete it on destruction, use the member function release to do so.
36c9828f	26
15b6757b	27	*/
36c9828f FM	28
36c9828f FM	29