dmIEventListener Class Reference

Event listener. More...

#include <CCI_EventListener.h>

Inherits dmINotify.

List of all members.

Public Member Functions

bool AddListener (dmTool *tool, dm_uint evtMask, dm_uint flags)
 Add an event listener to a tool.
bool RemoveListener (dmTool *tool, dm_uint evtMask, dm_uint flags)
 Remove an event listener from a tool.
bool GetMouseEvent (dm_point &pt, dm_uint &buttons, dm_uint &qual)
 Return the current mouse event attributs.
bool GetKeyEvent (dm_uint &code, dm_uint &qual)
 Return the current key event attributs.
bool StopPropagation ()
 Stop the propagation of the event.
dm_uint EventStatus ()
 Return the status of the current event.
bool GetToolInfo (cci_object *toolinfo)
 Initialize a dmIToolInfo object with the the current target.
dm_bool IsOriginalTarget ()
 Return true if the Current target is the original target.
dmTool * CurrentTarget ()
 Return the current target.


Detailed Description

Event listener.


Member Function Documentation

bool dmIEventListener::AddListener dmTool *  tool,
dm_uint  evtMask,
dm_uint  flags
[inline]
 

Add an event listener to a tool.

Parameters:
tool the target object associated width the event
evtMask mask of event type to be intercepted (
See also:
dmTk::dmEventType ) The mask should be a combination (OR) of dmEVENT_MASK(eventType) values.
Parameters:
flags Propagation flags: dmEVENT_FLAG_CAPTURE - listen for capturing events. dmEVENT_FLAG_BUBBLE - listen for bubbling events. ( see daim_event_model for details ).

dmTool* dmIEventListener::CurrentTarget  )  [inline]
 

Return the current target.

Return the target who has triggered the notification. i.e the target which is currently processing the event

See also:
IsOriginalTarget()

dm_bool dmIEventListener::IsOriginalTarget  )  [inline]
 

Return true if the Current target is the original target.

Return value is set to true when the target who has triggered the notification is the target related to that event

See also:
CurrentTarget()

bool dmIEventListener::RemoveListener dmTool *  tool,
dm_uint  evtMask,
dm_uint  flags
[inline]
 

Remove an event listener from a tool.

Parameters:
tool the target object associated width the event
evtMask mask of event type to be intercepted (
See also:
dmTk::dmEventType ) The mask should be a combination (OR) of dmEVENT_MASK(eventType) values.
Parameters:
flags Propagation flags: dmEVENT_FLAG_CAPTURE - listen for capturing events. dmEVENT_FLAG_BUBBLE - listen for bubbling events. ( see daim_event_model for details ).


Generated on Tue May 9 12:34:57 2006 for Daim Library Module Set by  doxygen 1.4.6-NO