wxShapeFramework  1.13.0 beta
wxSFShapeDropEvent Class Reference

Class encapsulates wxEVT_SF_ON_DROP event. More...

#include <SFEvents.h>

Collaboration diagram for wxSFShapeDropEvent:

List of all members.

Public Member Functions

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

Private Attributes

ShapeList m_lstDroppedShapes
 List of dropped shapes.
wxSFShapeCanvasm_pDropTarget
 Drop target.
wxPoint m_nDropPosition
 Drop position.
wxDragResult m_nDragResult
 Drag result.

Detailed Description

Class encapsulates wxEVT_SF_ON_DROP event.


Constructor & Destructor Documentation

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

Constructor.

Copy constructor.

Destructor.


Member Function Documentation

wxEvent* wxSFShapeDropEvent::Clone ( ) const [inline]

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

wxDragResult wxSFShapeDropEvent::GetDragResult ( ) [inline]

Get drag result.

Returns:
Drag result.
ShapeList& wxSFShapeDropEvent::GetDroppedShapes ( ) [inline]

Get a shape object from the event object.

Returns:
Pointer to the shape object.

Get drop position.

Returns:
Position.

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

Returns:
Pointer to drop target (shape canvas)
void wxSFShapeDropEvent::SetDragResult ( wxDragResult  def) [inline]

Set drag result.

Parameters:
defDrag result
void wxSFShapeDropEvent::SetDroppedShapes ( const ShapeList &  list)

Copy given shapes to the internal list of dropped shapes.

Parameters:
listReference to a list of copied shapes
void wxSFShapeDropEvent::SetDropPosition ( const wxPoint &  pos) [inline]

Set a position where the shapes were dropped.

Parameters:
posPosition

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

Parameters:
targetPointer to drop target (shape canvas)

Member Data Documentation

List of dropped shapes.

wxDragResult wxSFShapeDropEvent::m_nDragResult [private]

Drag result.

Drop position.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines