CEventHandler Class Reference

#include <CEventHandler.h>

Inheritance diagram for CEventHandler:

Public Member Functions
	CEventHandler (IPMUnknown *boss)
virtual	~CEventHandler ()
virtual bool16	Activate (IEvent *e)
virtual bool16	Deactivate (IEvent *e)
virtual bool16	Suspend (IEvent *e)
virtual bool16	Resume (IEvent *e)
virtual bool16	MouseMove (IEvent *e)
virtual bool16	MouseExit (IEvent *e)
virtual bool16	MouseDrag (IEvent *e)
virtual bool16	LButtonDn (IEvent *e)
virtual bool16	RButtonDn (IEvent *e)
virtual bool16	MButtonDn (IEvent *e)
virtual bool16	LButtonUp (IEvent *e)
virtual bool16	RButtonUp (IEvent *e)
virtual bool16	MButtonUp (IEvent *e)
virtual bool16	ButtonDblClk (IEvent *e)
virtual bool16	ButtonTrplClk (IEvent *e)
virtual bool16	ButtonQuadClk (IEvent *e)
virtual bool16	ButtonQuintClk (IEvent *e)
virtual bool16	MouseWheel (IEvent *e)
virtual bool16	TabletEvent (IEvent *e)
virtual bool16	GestureEvent (IEvent *e)
virtual bool16	MultiTouchEvent (IEvent *e)
virtual bool16	ControlCmd (IEvent *e)
virtual bool16	KeyDown (IEvent *e)
virtual bool16	KeyCmd (IEvent *e)
virtual bool16	KeyUp (IEvent *e)
virtual void	PreGetKeyFocus ()
virtual void	PostGetKeyFocus ()
virtual void	PreGiveUpKeyFocus ()
virtual void	PostGiveUpKeyFocus ()
virtual bool16	WillingToGiveUpKeyFocus ()
virtual bool16	SuspendKeyFocus ()
virtual bool16	ResumeKeyFocus ()
virtual bool16	CanHaveKeyFocus () const
virtual bool16	WantsTabKeyFocus () const
virtual bool16	Update (IEvent *e)
virtual bool16	PlatformEvent (IEvent *e)
virtual bool16	CallSysEventHandler (IEvent *e)
virtual void	SetView (IControlView *view)

Protected Attributes
IControlView *	fView

Additional Inherited Members
Public Types inherited from IEventHandler
enum	{ kDefaultIID = IID_IEVENTHANDLER }

Detailed Description

Entry-level implementation of IEventHandler, should be used for EventFilters or non-widget event handlers. use or derive from DVControlEventHandler or widget event handlers

Constructor & Destructor Documentation

CEventHandler::CEventHandler

(

IPMUnknown *

boss

)

Constructor

Parameters

boss	object on which this interface is aggregated

virtual CEventHandler::~CEventHandler ( )

virtual

Destructor

Member Function Documentation

virtual bool16 CEventHandler::Activate ( IEvent *  e )

virtual

Window has been activated. Traditional response is to activate the controls in the window.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CWindowEH.

virtual bool16 CEventHandler::ButtonDblClk ( IEvent *  e )

virtual

Double click with any button.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CWindowEH.

virtual bool16 CEventHandler::ButtonQuadClk ( IEvent *  e )

virtual

Quadruple click with any button.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::ButtonQuintClk ( IEvent *  e )

virtual

Quintuple click with any button.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::ButtonTrplClk ( IEvent *  e )

virtual

Triple click with any button.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CWindowEH.

virtual bool16 CEventHandler::CallSysEventHandler ( IEvent *  e )

virtual

Call the base system event handler.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

virtual bool16 CEventHandler::CanHaveKeyFocus ( ) const

virtual

Determine if this event handler wants to be focus.

Returns

kTrue if this eventhandler supports being the focus of keyboard events, kFalse otherwise

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::ControlCmd ( IEvent *  e )

virtual

Event for a particular control. Used only on Windows.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CWindowEH.

virtual bool16 CEventHandler::Deactivate ( IEvent *  e )

virtual

Window has been deactivated. Traditional response is to deactivate the controls in the window.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CTrackerEventHandler, CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CWindowEH.

virtual bool16 CEventHandler::KeyCmd ( IEvent *  e )

virtual

Keyboard key down that generates a character.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, CTrackerEventHandler, and CWindowEH.

virtual bool16 CEventHandler::KeyDown ( IEvent *  e )

virtual

Keyboard key down for every key. Normally, override KeyCmd, not KeyDown.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CTrackerEventHandler.

virtual bool16 CEventHandler::KeyUp ( IEvent *  e )

virtual

Keyboard key released.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, CTrackerEventHandler, and CWindowEH.

virtual bool16 CEventHandler::LButtonDn ( IEvent *  e )

virtual

Left mouse button (or only mouse button) has been pressed.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, CTrackerEventHandler, CusCondTxtIconEventHandler, and HiDPIWidgetEventHandler.

virtual bool16 CEventHandler::LButtonUp ( IEvent *  e )

virtual

Left mouse button released.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, CTrackerEventHandler, and CWindowEH.

virtual bool16 CEventHandler::MButtonDn ( IEvent *  e )

virtual

Middle mouse button of a 3 button mouse has been pressed.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::MButtonUp ( IEvent *  e )

virtual

Middle mouse button released.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::MouseDrag ( IEvent *  e )

virtual

User is holding down the mouse button and dragging the mouse.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, CTrackerEventHandler, and CWindowEH.

virtual bool16 CEventHandler::MouseExit ( IEvent *  e )

virtual

Mouse has exited the current control's bounds.

Parameters

e	event of interest

Returns

kTrue if event has been handled and should not be further dispatched, kFalse otherwise (pass event to next handler)

Implements IEventHandler.

virtual bool16 CEventHandler::MouseMove ( IEvent *  e )

virtual

Mouse has moved outside the sensitive region.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CWindowEH.

virtual bool16 CEventHandler::MouseWheel ( IEvent *  e )

virtual

Mouse wheel moved

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CTrackerEventHandler.

virtual bool16 CEventHandler::MultiTouchEvent ( IEvent *  e )

virtual

MultiTouchEvents events New for CC

Parameters

e	event of interest

Returns

kTrue if event has been handled and should not be further dispatched, kFalse otherwise (pass event to next handler)

Implements IEventHandler.

virtual bool16 CEventHandler::PlatformEvent ( IEvent *  e )

virtual

Method to handle platform specific events

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

virtual void CEventHandler::PostGetKeyFocus ( )

inlinevirtual

Called after getting focus onto the associated widget/window

Parameters

none

Returns

none

Implements IEventHandler.

virtual void CEventHandler::PostGiveUpKeyFocus ( )

inlinevirtual

Called after giving up focus onto the associated widget/window

Parameters

none

Returns

none

Implements IEventHandler.

virtual void CEventHandler::PreGetKeyFocus ( )

inlinevirtual

Called before getting focus onto the associated widget/window

Parameters

none

Returns

none

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual void CEventHandler::PreGiveUpKeyFocus ( )

inlinevirtual

Called before giving up focus onto the associated widget/window

Parameters

none

Returns

none

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::RButtonDn ( IEvent *  e )

virtual

Right mouse button (or second button) has been pressed.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, CTrackerEventHandler, and PnlTrvNodeEH.

virtual bool16 CEventHandler::RButtonUp ( IEvent *  e )

virtual

Right mouse button released.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, PnlTrvNodeEH, and CTrackerEventHandler.

virtual bool16 CEventHandler::Resume ( IEvent *  e )

virtual

Application has been resumed. Control is passed back to the application from another application.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::ResumeKeyFocus ( )

virtual

The keyboard has been handed back.

Returns

kTrue if you really resumed yourself. Otherwise, return kFalse.

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual void CEventHandler::SetView ( IControlView *  view )

virtual

Temporary.

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::Suspend ( IEvent *  e )

virtual

Application has been suspended. Control is passed to another application.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Implements IEventHandler.

Reimplemented in CTrackerEventHandler, CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::SuspendKeyFocus ( )

virtual

The keyboard is temporarily being taken away. Remember enough state to resume where you left off.

Returns

kTrue if you really suspended yourself. If you simply gave up the keyboard, return kFalse.

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::TabletEvent ( IEvent *  e )

virtual

Tablet and Gesture events New for CC, previously these would come through PlatformEvent

Parameters

e	event of interest

Returns

kTrue if event has been handled and should not be further dispatched, kFalse otherwise (pass event to next handler)

Implements IEventHandler.

virtual bool16 CEventHandler::Update ( IEvent *  e )

virtual

Window needs to repaint.

Parameters

e	event of interest

Returns

kTrue if event was handled, kFalse to propagate event, i.e. pass to next handler

Reimplemented in CWindowEH.

virtual bool16 CEventHandler::WantsTabKeyFocus ( ) const

virtual

Determine if this event handler wants to get focus from tabbing through controls.

Returns

kTrue if this event handler wants to get keyboard focus while tabbing through widgets, kFalse otherwise

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.

virtual bool16 CEventHandler::WillingToGiveUpKeyFocus ( )

virtual

Typically called before focus is given up.

Returns

kFalse to hold onto the keyboard focus, kTrue otherwise

Implements IEventHandler.

Reimplemented in CusDtLnkUITreeNodeEH, and PnlTrvNodeEH.