wxSFShapeDropEvent Class Reference

Class encapsulates wxEVT_SF_ON_DROP event. More...

#include <SFEvents.h>

Inheritance diagram for wxSFShapeDropEvent:

Collaboration diagram for wxSFShapeDropEvent:

Public Member Functions
	wxSFShapeDropEvent (wxEventType cmdType=wxEVT_NULL, wxCoord x=0, wxCoord y=0, wxSFShapeCanvas *target=NULL, wxDragResult def=wxDragNone, int id=0)
	Constructor. More...
	wxSFShapeDropEvent (const wxSFShapeDropEvent &obj)
	Copy constructor. More...
virtual	~wxSFShapeDropEvent ()
	Destructor. More...
void	SetDroppedShapes (const ShapeList &list)
	Copy given shapes to the internal list of dropped shapes. More...
void	SetDropPosition (const wxPoint &pos)
	Set a position where the shapes were dropped. More...
void	SetDragResult (wxDragResult def)
	Set drag result. More...
void	SetDropTarget (wxSFShapeCanvas *target)
	Set drop target (shape canvas where shapes have been dropped to). More...
ShapeList &	GetDroppedShapes ()
	Get a shape object from the event object. More...
wxPoint	GetDropPosition ()
	Get drop position. More...
wxDragResult	GetDragResult ()
	Get drag result. More...
wxSFShapeCanvas *	GetDropTarget ()
	Get drop target (shape canvas where shapes have been dropped to). More...
wxEvent *	Clone () const
	Clone this event object and return pointer to the new instance. More...

Private Attributes
ShapeList	m_lstDroppedShapes
	List of dropped shapes. More...
wxSFShapeCanvas *	m_pDropTarget
	Drop target. More...
wxPoint	m_nDropPosition
	Drop position. More...
wxDragResult	m_nDragResult
	Drag result. More...

Detailed Description

Class encapsulates wxEVT_SF_ON_DROP event.

Constructor & Destructor Documentation

wxSFShapeDropEvent() [1/2]

wxSFShapeDropEvent::wxSFShapeDropEvent	(	wxEventType	cmdType = wxEVT_NULL,
		wxCoord	x = 0,
		wxCoord	y = 0,
		wxSFShapeCanvas *	target = NULL,
		wxDragResult	def = wxDragNone,
		int	id = 0
	)

Constructor.

wxSFShapeDropEvent() [2/2]

wxSFShapeDropEvent::wxSFShapeDropEvent

(

const wxSFShapeDropEvent &

obj

)

Copy constructor.

~wxSFShapeDropEvent()

virtual wxSFShapeDropEvent::~wxSFShapeDropEvent ( )

virtual

Destructor.

Member Function Documentation

Clone()

wxEvent* wxSFShapeDropEvent::Clone ( ) const

inline

Clone this event object and return pointer to the new instance.

GetDragResult()

wxDragResult wxSFShapeDropEvent::GetDragResult ( )

inline

Get drag result.

Returns

Drag result.

GetDroppedShapes()

ShapeList& wxSFShapeDropEvent::GetDroppedShapes ( )

inline

Get a shape object from the event object.

Returns

Pointer to the shape object.

GetDropPosition()

wxPoint wxSFShapeDropEvent::GetDropPosition ( )

inline

Get drop position.

Returns

Position.

GetDropTarget()

wxSFShapeCanvas* wxSFShapeDropEvent::GetDropTarget ( )

inline

Get drop target (shape canvas where shapes have been dropped to).

Returns

Pointer to drop target (shape canvas)

SetDragResult()

void wxSFShapeDropEvent::SetDragResult ( wxDragResult  def )

inline

Set drag result.

Parameters

def	Drag result

SetDroppedShapes()

void wxSFShapeDropEvent::SetDroppedShapes

(

const ShapeList &

list

)

Copy given shapes to the internal list of dropped shapes.

Parameters

list	Reference to a list of copied shapes

SetDropPosition()

void wxSFShapeDropEvent::SetDropPosition ( const wxPoint &  pos )

inline

Set a position where the shapes were dropped.

Parameters

pos

Position

SetDropTarget()

void wxSFShapeDropEvent::SetDropTarget ( wxSFShapeCanvas *  target )

inline

Set drop target (shape canvas where shapes have been dropped to).

Parameters

target

Pointer to drop target (shape canvas)

Member Data Documentation

m_lstDroppedShapes

ShapeList wxSFShapeDropEvent::m_lstDroppedShapes

private

List of dropped shapes.

m_nDragResult

wxDragResult wxSFShapeDropEvent::m_nDragResult

private

Drag result.

m_nDropPosition

wxPoint wxSFShapeDropEvent::m_nDropPosition

private

Drop position.

m_pDropTarget

wxSFShapeCanvas* wxSFShapeDropEvent::m_pDropTarget

private

Drop target.

---

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

• SFEvents.h