## wxCustomDataObject

wxCustomDataObject is a specialization of wxDataObjectSimple for some application-specific data in arbitrary (either custom or one of the standard ones). The only restriction is that it is supposed that this data can be copied bitwise (i.e. with `memcpy()`), so it would be a bad idea to make it contain a C++ object (though C struct is fine).

By default, wxCustomDataObject stores the data inside in a buffer. To put the data into the buffer you may use either SetData or TakeData depending on whether you want the object to make a copy of data or not.

If you already store the data in another place, it may be more convenient and efficient to provide the data on-demand which is possible too if you override the virtual functions mentioned below.

Virtual functions to override

This class may be used as is, but if you don't want store the data inside the object but provide it on demand instead, you should override GetSize, GetData and SetData (or may be only the first two or only the last one if you only allow reading/writing the data)

Derived from

wxDataObjectSimple
wxDataObject

Include files

<wx/dataobj.h>

See also

wxDataObject

Members

wxCustomDataObject::wxCustomDataObject
wxCustomDataObject::~wxCustomDataObject
wxCustomDataObject::Alloc
wxCustomDataObject::Free
wxCustomDataObject::GetSize
wxCustomDataObject::GetData
wxCustomDataObject::SetData
wxCustomDataObject::TakeData

### wxCustomDataObject::wxCustomDataObject

wxCustomDataObject(const wxDataFormat& format = wxFormatInvalid)

The constructor accepts a format argument which specifies the (single) format supported by this object. If it isn't set here, SetFormat should be used.

### wxCustomDataObject::~wxCustomDataObject

~wxCustomDataObject()

The destructor will free the data hold by the object. Notice that although it calls a virtual Free() function, the base class version will always be called (C++ doesn't allow calling virtual functions from constructors or destructors), so if you override `Free()`, you should override the destructor in your class as well (which would probably just call the derived class' version of `Free()`).

### wxCustomDataObject::Alloc

virtual void * Alloc(size_t size)

This function is called to allocate size bytes of memory from SetData(). The default version just uses the operator new.

### wxCustomDataObject::Free

wxPython note: This method expects a string in wxPython. You can pass nearly any object by pickling it first.

virtual void Free()

This function is called when the data is freed, you may override it to anything you want (or may be nothing at all). The default version calls operator delete[] on the data.

### wxCustomDataObject::GetSize

virtual size_t GetSize() const

Returns the data size in bytes.

### wxCustomDataObject::GetData

virtual void * GetData() const

Returns a pointer to the data.

### wxCustomDataObject::SetData

virtual void SetData( size_t size, const void *data)

Set the data. The data object will make an internal copy.

### wxCustomDataObject::TakeData

virtual void TakeData( size_t size, const void *data)

Like SetData, but doesn't copy the data - instead the object takes ownership of the pointer.