wxArt2D
Public Member Functions | Static Public Attributes | Friends | List of all members

see a2dComEvent More...

#include <gen.h>

Inheritance diagram for a2dComEvent:
Inheritance graph
[legend]
Collaboration diagram for a2dComEvent:
Collaboration graph
[legend]

Public Member Functions

 a2dComEvent (wxObject *sender, a2dSignal id)
 for sending just an event id, m_property is not set
 
 a2dComEvent (a2dObject *sender, const a2dPropertyId *id, a2dSignal=sm_changedProperty)
 sent a property id ( in order to get property on sender object ) More...
 
 a2dComEvent (wxObject *sender, a2dNamedProperty *property, a2dSignal id=sm_changedProperty, bool ownProp=false)
 sent a property More...
 
 a2dComEvent (wxObject *sender, const a2dNamedProperty &property, a2dSignal eventid=sm_changedProperty)
 sent a property by reference More...
 
 a2dComEvent (wxObject *sender, a2dObject *refObject, a2dSignal id=sm_changedRefObject)
 sent a property generated from a a2dObject. More...
 
 a2dComEvent (wxObject *sender, const a2dPropertyIdRefObject *propId, a2dObject *refObject, a2dSignal id=sm_changedProperty)
 sent a property id ( in order to get property on sender object ) More...
 
 a2dComEvent (wxObject *sender, const a2dPropertyIdBool *propId, bool propertyValue, a2dSignal id=sm_changedProperty)
 sent a property generated from a bool.
 
 a2dComEvent (wxObject *sender, const a2dPropertyIdUint16 *propId, wxUint16 propertyValue, a2dSignal id=sm_changedProperty)
 sent a property generated from a wxUint16.
 
 a2dComEvent (wxObject *sender, const a2dPropertyIdInt32 *propId, wxInt32 propertyValue, a2dSignal id=sm_changedProperty)
 sent a property generated from a wxInt32.
 
 a2dComEvent (wxObject *sender, const a2dPropertyIdDouble *propId, double propertyValue, a2dSignal id=sm_changedProperty)
 sent a property generated from a double.
 
 a2dComEvent (wxObject *sender, const a2dPropertyIdString *propId, const wxString &propertyValue, a2dSignal id=sm_changedProperty)
 sent a property generated from a wxString.
 
 a2dComEvent (wxObject *sender, bool propertyValue, a2dSignal id)
 sent a property generated from a bool.
 
 a2dComEvent (wxObject *sender, wxInt16 propertyValue, a2dSignal id)
 sent a property generated from a wxIint16.
 
 a2dComEvent (wxObject *sender, wxUint16 propertyValue, a2dSignal id)
 sent a property generated from a wxUint16.
 
 a2dComEvent (wxObject *sender, wxInt32 propertyValue, a2dSignal id)
 sent a property generated from a wxInt32.
 
 a2dComEvent (wxObject *sender, wxUint32 propertyValue, a2dSignal id)
 sent a property generated from a wxUint32.
 
 a2dComEvent (wxObject *sender, double propertyValue, a2dSignal id)
 sent a property generated from a double.
 
 a2dComEvent (wxObject *sender, const wxString &propertyValue, a2dSignal id)
 sent a property generated from a wxString.
 
 a2dComEvent (const a2dComEvent &other)
 
wxEvent * Clone (void) const
 
a2dNamedPropertyGetProperty ()
 
const a2dPropertyIdGetPropertyId () const
 
a2dSignal GetEventComIdReturn ()
 after proecssin the event, on return an id can be set to communicate back to sender.
 

Static Public Attributes

static const a2dSignal sm_changedProperty = wxNewId()
 
static const a2dSignal sm_changedRefObject = wxNewId()
 
static const a2dSignal sm_non = wxNewId()
 

Friends

class a2dSmrtPtrBase
 

Detailed Description

see a2dComEvent

special event for communicating between a2dObject's and GUI objects and Command processors.

Used for communicating and distributing events which change e.g. a2dObject's

The information that is sent around is stored in a a2dNamedProperty.

To intercept this event ( when sent to an object ), use the next event table entries:

event id's for Change events used for specifying which type of information is communicated via a a2dComEvent event.

The idea is to add static members like this to a class you wnat to sent an event from. Like in a2dCanvasObject we have in the header file:

const static a2dComEvent::wxEventType sm_changedLayer;

and in the cpp file do initilize the static member:

const a2dComEvent::wxEventType a2dCanvasDocument::sm_changedLayer;

and in the cpp file do sent an event from member function:

a2dComEvent changedlayer( this, PROPID_layer, layer, &sm_changedLayer );
ProcessEvent( changedlayer );
BEGIN_EVENT_TABLE( anyclass, wxWindow )
EVT_COM_EVENT( anyclass::OnComEvent )
END_EVENT_TABLE()
void anyclass::OnComEvent( a2dComEvent& event )
{
if ( event.GetId() == &sm_changedLayer )
{
DoIt();
}
}
See Also
a2dGeneralGlobals
a2dComEvent

Definition at line 371 of file gen.h.

Constructor & Destructor Documentation

a2dComEvent::a2dComEvent ( a2dObject sender,
const a2dPropertyId id,
a2dSignal  id = sm_changedProperty 
)

sent a property id ( in order to get property on sender object )

Parameters
senderthe object which did sent this event.
idid of the property in the sender object
eventideventid is to further specify the nature of the event.

Definition at line 5331 of file gen.cpp.

a2dComEvent::a2dComEvent ( wxObject *  sender,
a2dNamedProperty property,
a2dSignal  id = sm_changedProperty,
bool  ownProp = false 
)

sent a property

Parameters
senderthe object which did sent this event.
propertythe property to sent
ideventid is to further specify the nature of the event.
ownPropwhen true the property will be cloned and deleted here

Definition at line 5341 of file gen.cpp.

a2dComEvent::a2dComEvent ( wxObject *  sender,
const a2dNamedProperty property,
a2dSignal  eventid = sm_changedProperty 
)

sent a property by reference

Parameters
senderthe object which did sent this event.
propertythe property to sent
eventideventid is to further specify the nature of the event.

Definition at line 5354 of file gen.cpp.

a2dComEvent::a2dComEvent ( wxObject *  sender,
a2dObject refObject,
a2dSignal  id = sm_changedRefObject 
)

sent a property generated from a a2dObject.

Creates a wxRefObjectPtrProperty internal.

Parameters
senderthe object which did sent this event.
refObjectthe a2dObject
eventideventid is to further specify the nature of the event.

Definition at line 5364 of file gen.cpp.

a2dComEvent::a2dComEvent ( wxObject *  sender,
const a2dPropertyIdRefObject propId,
a2dObject refObject,
a2dSignal  id = sm_changedProperty 
)

sent a property id ( in order to get property on sender object )

Parameters
senderthe object which did sent this event.
idid of the property in the sender object
eventideventid is to further specify the nature of the event.sent a property generated from a a2dObject.

Definition at line 5374 of file gen.cpp.


The documentation for this class was generated from the following files:
a2dComEvent Class Reference -- Sun Oct 12 2014 17:04:31 -- Sun Oct 12 2014 -- 1.8.5 -- wxArt2D -- . -- Main Page Reference Documentation