wxShapeFramework  1.13.0 beta
wxSFShapeDataObject Class Reference

Class encapsulating data object used during clipboard operations with shapes. More...

#include <ShapeDataObject.h>

Inheritance diagram for wxSFShapeDataObject:
Collaboration diagram for wxSFShapeDataObject:

Public Member Functions

 wxSFShapeDataObject (const wxDataFormat &format)
 Default constructor. More...
 
 wxSFShapeDataObject (const wxDataFormat &format, const ShapeList &selection, wxSFDiagramManager *manager)
 User constructor. More...
 
virtual ~wxSFShapeDataObject (void)
 Destructor. More...
 
virtual size_t GetDataSize () const
 Function returns sizes of the data object. More...
 
virtual bool GetDataHere (void *buf) const
 Function should export data from data object to given buffer. More...
 
virtual bool SetData (size_t len, const void *buf)
 Function should inport data from data object from given buffer. More...
 

Public Attributes

wxTextDataObject m_Data
 

Protected Member Functions

wxString SerializeSelectedShapes (const ShapeList &selection, wxSFDiagramManager *manager)
 Serialize shapes to data object. More...
 

Detailed Description

Class encapsulating data object used during clipboard operations with shapes.

Constructor & Destructor Documentation

◆ wxSFShapeDataObject() [1/2]

wxSFShapeDataObject::wxSFShapeDataObject ( const wxDataFormat &  format)

Default constructor.

Parameters
formatData format

◆ wxSFShapeDataObject() [2/2]

wxSFShapeDataObject::wxSFShapeDataObject ( const wxDataFormat &  format,
const ShapeList &  selection,
wxSFDiagramManager manager 
)

User constructor.

Parameters
formatData format
selectionList of shapes which should be stored in the data object
managerPointer to diagram manager which manages stored shapes

◆ ~wxSFShapeDataObject()

virtual wxSFShapeDataObject::~wxSFShapeDataObject ( void  )
virtual

Destructor.

Member Function Documentation

◆ GetDataHere()

virtual bool wxSFShapeDataObject::GetDataHere ( void *  buf) const
virtual

Function should export data from data object to given buffer.

Parameters
bufExternal output data buffer
Returns
TRUE on success, otherwise FALSE

◆ GetDataSize()

virtual size_t wxSFShapeDataObject::GetDataSize ( ) const
virtual

Function returns sizes of the data object.

◆ SerializeSelectedShapes()

wxString wxSFShapeDataObject::SerializeSelectedShapes ( const ShapeList &  selection,
wxSFDiagramManager manager 
)
protected

Serialize shapes to data object.

Parameters
selectionList of shapes which should be serialized
managerParent diagram manager
Returns
String containing serialized information

◆ SetData()

virtual bool wxSFShapeDataObject::SetData ( size_t  len,
const void *  buf 
)
virtual

Function should inport data from data object from given buffer.

Parameters
lenData lenght
bufExternal input data buffer
Returns
TRUE on success, otherwise FALSE

Member Data Documentation

◆ m_Data

wxTextDataObject wxSFShapeDataObject::m_Data

The documentation for this class was generated from the following file: