wxShapeFramework  1.13.0 beta
wxSFShapeEvent Class Reference

Class encapsulates generic wxSF shape's event. More...

#include <SFEvents.h>

Inheritance diagram for wxSFShapeEvent:
Collaboration diagram for wxSFShapeEvent:

Public Member Functions

 wxSFShapeEvent (wxEventType cmdType=wxEVT_NULL, int id=0)
 Constructor. More...
 
 wxSFShapeEvent (const wxSFShapeEvent &obj)
 Copy constructor. More...
 
virtual ~wxSFShapeEvent ()
 Destructor. More...
 
void SetShape (wxSFShapeBase *shape)
 Insert a shape object to the event object. More...
 
wxSFShapeBaseGetShape ()
 Get a shape object from the event object. More...
 
wxEvent * Clone () const
 Clone this event object and return pointer to the new instance. More...
 
bool IsVetoed ()
 Check if the event has been vetoed or not. More...
 
void Veto ()
 Set the veto flag to true. More...
 

Private Attributes

wxSFShapeBasem_Shape
 Pointer to stored shape object. More...
 
bool m_Vetoed
 

Detailed Description

Class encapsulates generic wxSF shape's event.

Constructor & Destructor Documentation

◆ wxSFShapeEvent() [1/2]

wxSFShapeEvent::wxSFShapeEvent ( wxEventType  cmdType = wxEVT_NULL,
int  id = 0 
)

Constructor.

◆ wxSFShapeEvent() [2/2]

wxSFShapeEvent::wxSFShapeEvent ( const wxSFShapeEvent obj)

Copy constructor.

◆ ~wxSFShapeEvent()

virtual wxSFShapeEvent::~wxSFShapeEvent ( )
virtual

Destructor.

Member Function Documentation

◆ Clone()

wxEvent* wxSFShapeEvent::Clone ( ) const
inline

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

◆ GetShape()

wxSFShapeBase* wxSFShapeEvent::GetShape ( )
inline

Get a shape object from the event object.

Returns
Pointer to the shape object.

◆ IsVetoed()

bool wxSFShapeEvent::IsVetoed ( )
inline

Check if the event has been vetoed or not.

Returns
TRUE if the event has been vetoed.

◆ SetShape()

void wxSFShapeEvent::SetShape ( wxSFShapeBase shape)
inline

Insert a shape object to the event object.

Parameters
shapePointer to the shape object

◆ Veto()

void wxSFShapeEvent::Veto ( )
inline

Set the veto flag to true.

Member Data Documentation

◆ m_Shape

wxSFShapeBase* wxSFShapeEvent::m_Shape
private

Pointer to stored shape object.

◆ m_Vetoed

bool wxSFShapeEvent::m_Vetoed
private

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