DVHostedWidgetEH Class Reference

#include <DVHostedWidgetEH.h>

Inheritance diagram for DVHostedWidgetEH:

Public Member Functions
	DVHostedWidgetEH (IPMUnknown *boss)
virtual bool16	Activate (IEvent *)
virtual bool16	Deactivate (IEvent *)
virtual bool16	Suspend (IEvent *)
virtual bool16	Resume (IEvent *)
virtual bool16	MouseMove (IEvent *)
virtual bool16	MouseExit (IEvent *)
virtual bool16	MouseDrag (IEvent *)
virtual bool16	LButtonDn (IEvent *)
virtual bool16	RButtonDn (IEvent *)
virtual bool16	MButtonDn (IEvent *)
virtual bool16	LButtonUp (IEvent *)
virtual bool16	RButtonUp (IEvent *)
virtual bool16	MButtonUp (IEvent *)
virtual bool16	ButtonDblClk (IEvent *)
virtual bool16	ButtonTrplClk (IEvent *)
virtual bool16	ButtonQuadClk (IEvent *)
virtual bool16	ButtonQuintClk (IEvent *)
virtual bool16	MouseWheel (IEvent *)
virtual bool16	TabletEvent (IEvent *)
virtual bool16	GestureEvent (IEvent *)
virtual bool16	MultiTouchEvent (IEvent *)
virtual bool16	BaseHandlePointerEvent (IEvent *)
virtual bool16	KeyDown (IEvent *)
virtual bool16	KeyCmd (IEvent *)
virtual bool16	KeyUp (IEvent *)
virtual bool16	BaseHandleKeyboardEvent (IEvent *)
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	ControlCmd (IEvent *)
virtual bool16	Update (IEvent *)
virtual bool16	PlatformEvent (IEvent *)
virtual bool16	CallSysEventHandler (IEvent *)
virtual void	SetView (IControlView *)
virtual const char *	class_name ()

Protected Member Functions
dvaui::ui::UI_Node *	Get_UI_Node () const

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

Detailed Description

IEventHandler baseclass used for widgets in the Drover world.

The theory going forward is that most of what our existing IEventHandlers do will be replaced by the default behavior of the drover widgets themselves. Thus an IEventHandler will typically not be necessary, unless our version of the widget expects to do something unusual, and even then that code may not reside in an IEventHandler interface.

Member Function Documentation

virtual bool16 DVHostedWidgetEH::Activate ( IEvent *  e )

inlinevirtual

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

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 DVHostedWidgetEH::ButtonDblClk ( IEvent *  e )

virtual

Double click with any button.

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 DVHostedWidgetEH::ButtonQuadClk ( IEvent *  e )

virtual

Quadruple click with any button.

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.

Reimplemented in MenuPopupEventHandler.

virtual bool16 DVHostedWidgetEH::ButtonQuintClk ( IEvent *  e )

virtual

Quintuple click with any button.

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.

Reimplemented in MenuPopupEventHandler.

virtual bool16 DVHostedWidgetEH::ButtonTrplClk ( IEvent *  e )

virtual

Triple click with any button.

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.

Reimplemented in MenuPopupEventHandler.

virtual bool16 DVHostedWidgetEH::CanHaveKeyFocus ( ) const

virtual

Determine if this eventhandler can be focus of keyboard event

Returns

kTrue if this eventhandler supports being the focus of keyboard event

Implements IEventHandler.

Reimplemented in C9PointProxyEH, MenuPopupEventHandler, and DVEditBoxEventHandler.

virtual bool16 DVHostedWidgetEH::ControlCmd ( IEvent *  e )

inlinevirtual

Event for a particular control. Used only on Windows.

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 DVHostedWidgetEH::Deactivate ( IEvent *  e )

inlinevirtual

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

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 DVHostedWidgetEH::KeyCmd ( IEvent *  e )

virtual

Keyboard key down that generates a character.

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.

Reimplemented in DVToolControlEventHandler.

virtual bool16 DVHostedWidgetEH::KeyDown ( IEvent *  e )

virtual

Keyboard key down for every key. Normally you want to override KeyCmd, rather than KeyDown.

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.

Reimplemented in C9PointProxyEH, CelPnlEditBoxEventHandler, MenuPopupEventHandler, DVEditBoxEventHandler, and DVToolControlEventHandler.

virtual bool16 DVHostedWidgetEH::KeyUp ( IEvent *  e )

virtual

Keyboard key released.

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.

Reimplemented in DVToolControlEventHandler.

virtual bool16 DVHostedWidgetEH::LButtonDn ( IEvent *  e )

virtual

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

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.

Reimplemented in C9PointProxyEH, PicIcoPictureWidgetEH, DVEditBoxEventHandler, DVToolControlEventHandler, and MenuPopupEventHandler.

virtual bool16 DVHostedWidgetEH::LButtonUp ( IEvent *  e )

virtual

Left mouse button released.

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.

Reimplemented in TableCellEventHandler, MenuPopupEventHandler, and DVToolControlEventHandler.

virtual bool16 DVHostedWidgetEH::MButtonDn ( IEvent *  e )

virtual

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

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 DVHostedWidgetEH::MButtonUp ( IEvent *  e )

virtual

Middle mouse button released.

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 DVHostedWidgetEH::MouseDrag ( IEvent *  e )

virtual

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

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 DVHostedWidgetEH::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 DVHostedWidgetEH::MouseMove ( IEvent *  e )

virtual

Mouse has moved outside the sensitive region.

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 DVHostedWidgetEH::MouseWheel ( IEvent *  e )

virtual

Mouse wheel moved

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 DVHostedWidgetEH::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 void DVHostedWidgetEH::PostGetKeyFocus ( )

inlinevirtual

Called after getting focus onto the associated widget/window

Parameters

none

Returns

none

Implements IEventHandler.

Reimplemented in C9PointProxyEH, and DVEditBoxEventHandler.

virtual void DVHostedWidgetEH::PostGiveUpKeyFocus ( )

inlinevirtual

Called after giving up focus onto the associated widget/window

Parameters

none

Returns

none

Implements IEventHandler.

Reimplemented in C9PointProxyEH, and DVEditBoxEventHandler.

virtual void DVHostedWidgetEH::PreGetKeyFocus ( )

inlinevirtual

Called before getting focus onto the associated widget/window

Parameters

none

Returns

none

Implements IEventHandler.

virtual void DVHostedWidgetEH::PreGiveUpKeyFocus ( )

inlinevirtual

Called before giving up focus onto the associated widget/window

Parameters

none

Returns

none

Implements IEventHandler.

virtual bool16 DVHostedWidgetEH::RButtonDn ( IEvent *  e )

virtual

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

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 DVHostedWidgetEH::RButtonUp ( IEvent *  e )

virtual

Right mouse button released.

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 DVHostedWidgetEH::Resume ( IEvent *  e )

inlinevirtual

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

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 DVHostedWidgetEH::ResumeKeyFocus ( )

virtual

The keyboard has been handed back.

Returns

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

Implements IEventHandler.

virtual void DVHostedWidgetEH::SetView ( IControlView *  view )

inlinevirtual

Temporary.

Implements IEventHandler.

virtual bool16 DVHostedWidgetEH::Suspend ( IEvent *  e )

inlinevirtual

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

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 DVHostedWidgetEH::SuspendKeyFocus ( )

virtual

The keyboard focus if going to be taken offis 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.

virtual bool16 DVHostedWidgetEH::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 DVHostedWidgetEH::WantsTabKeyFocus ( ) const

virtual

Return kTrue if this event handler wants to get keyboard focus while tabbing through widgets. Note: For almost all event handlers CanHaveKeyFocus and WantsTabKeyFocus will return the same value. If WantsTabKeyFocus returns kTrue then CanHaveKeyFocus should also return kTrue for the event handler to actually get keyboard focus. If WantsTabKeyFocus returns kFalse then the event handler is skipped.

Returns

kTrue if event handler wants to get focus during tabbing, kFalse otherwise

Implements IEventHandler.

Reimplemented in DVEditBoxEventHandler.

virtual bool16 DVHostedWidgetEH::WillingToGiveUpKeyFocus ( )

virtual

Typically called before the keyfocus is taken from the widget/window is called. Return kFalse to hold onto the keyboard focus.

Returns

kFalse to hold onto the keyboard focus

Implements IEventHandler.

Reimplemented in DVEditBoxEventHandler.