PnlTrvNodeEH Class Reference

Inheritance diagram for PnlTrvNodeEH:

Public Member Functions
	PnlTrvNodeEH (IPMUnknown *boss)
virtual	~PnlTrvNodeEH ()
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	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	ControlCmd (IEvent *e)
virtual bool16	KeyDown (IEvent *e)
virtual bool16	KeyCmd (IEvent *e)
virtual bool16	KeyUp (IEvent *e)
virtual void	PreGetKeyFocus ()
virtual void	PreGiveUpKeyFocus ()
virtual bool16	WillingToGiveUpKeyFocus ()
virtual bool16	SuspendKeyFocus ()
virtual bool16	ResumeKeyFocus ()
virtual bool16	CanHaveKeyFocus () const
virtual bool16	WantsTabKeyFocus () const
virtual void	SetView (IControlView *view)
Public Member Functions inherited from CEventHandler
	CEventHandler (IPMUnknown *boss)
virtual	~CEventHandler ()
virtual bool16	MouseExit (IEvent *e)
virtual bool16	TabletEvent (IEvent *e)
virtual bool16	GestureEvent (IEvent *e)
virtual bool16	MultiTouchEvent (IEvent *e)
virtual void	PostGetKeyFocus ()
virtual void	PostGiveUpKeyFocus ()
virtual bool16	Update (IEvent *e)
virtual bool16	PlatformEvent (IEvent *e)
virtual bool16	CallSysEventHandler (IEvent *e)

Additional Inherited Members
Public Types inherited from IEventHandler
enum	{ kDefaultIID = IID_IEVENTHANDLER }
Protected Attributes inherited from CEventHandler
IControlView *	fView

Detailed Description

Implements IEventHandler; allows this plug-in's code to catch the double-click events without needing access to the implementation headers.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * PnlTrvNodeEH::PnlTrvNodeEH

(

IPMUnknown *

boss

)

Constructor.

Parameters

boss	interface ptr on the boss object to which the interface implemented here belongs.

virtual PnlTrvNodeEH::~PnlTrvNodeEH ( )

inlinevirtual

Destructor

Member Function Documentation

virtual bool16 PnlTrvNodeEH::Activate ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

bool16 PnlTrvNodeEH::ButtonDblClk ( IEvent *  e )

virtual

Double click with any button; this is the only event that we're interested in here- on this event we load the placegun with an asset if it can be imported.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::ButtonQuadClk ( IEvent *  e )

inlinevirtual

Quadruple click with any button.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::ButtonQuintClk ( IEvent *  e )

inlinevirtual

Quintuple click with any button.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::ButtonTrplClk ( IEvent *  e )

inlinevirtual

Triple click with any button.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::CanHaveKeyFocus ( ) const

inlinevirtual

Determine if this eventhandler can be focus of keyboard event

Returns

kTrue if this eventhandler supports being the focus of keyboard event

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::ControlCmd ( IEvent *  e )

inlinevirtual

Event for a particular control. Used only on Windows.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::Deactivate ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::KeyCmd ( IEvent *  e )

inlinevirtual

Keyboard key down that generates a character.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::KeyDown ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::KeyUp ( IEvent *  e )

inlinevirtual

Keyboard key released.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::LButtonDn ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::LButtonUp ( IEvent *  e )

inlinevirtual

Left mouse button released.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::MButtonDn ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::MButtonUp ( IEvent *  e )

inlinevirtual

Middle mouse button released.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::MouseDrag ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::MouseMove ( IEvent *  e )

inlinevirtual

Mouse has moved outside the sensitive region.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::MouseWheel ( IEvent *  e )

inlinevirtual

mouse scroll wheel

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual void PnlTrvNodeEH::PreGetKeyFocus ( )

inlinevirtual

Key focus is now passed to the window.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual void PnlTrvNodeEH::PreGiveUpKeyFocus ( )

inlinevirtual

Window has lost key focus.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::RButtonDn ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::RButtonUp ( IEvent *  e )

inlinevirtual

Right mouse button released.

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::Resume ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::ResumeKeyFocus ( )

inlinevirtual

The keyboard has been handed back.

Returns

kTrue if you resumed yourself. Otherwise, return kFalse.

Reimplemented from CEventHandler.

virtual void PnlTrvNodeEH::SetView ( IControlView *  view )

inlinevirtual

Temporary.

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::Suspend ( IEvent *  e )

inlinevirtual

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

Parameters

e	[IN] event of interest

Returns

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::SuspendKeyFocus ( )

inlinevirtual

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.

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::WantsTabKeyFocus ( ) const

inlinevirtual

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

Reimplemented from CEventHandler.

virtual bool16 PnlTrvNodeEH::WillingToGiveUpKeyFocus ( )

inlinevirtual

Typically called before GiveUpKeyFocus() is called. Return kFalse to hold onto the keyboard focus.

Returns

kFalse to hold onto the keyboard focus

Reimplemented from CEventHandler.