"

 COPYRIGHT (c) 1993 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

Object subclass:#WindowEvent

	instanceVariableNames:'view type arguments delegated consumed'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-Support'

!

WindowEvent subclass:#InputEvent

	instanceVariableNames:'modifierFlags'

	classVariableNames:'F_CTRL F_ALT F_META F_SHIFT F_BUTTON1 F_BUTTON2 F_BUTTON3'

	poolDictionaries:''

	privateIn:WindowEvent

!

WindowEvent subclass:#ClientEvent

	instanceVariableNames:'eventData'

	classVariableNames:''

	poolDictionaries:''

	privateIn:WindowEvent

!

WindowEvent::InputEvent subclass:#FocusEvent

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:WindowEvent

!

WindowEvent::InputEvent subclass:#ButtonEvent

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:WindowEvent

!

WindowEvent::InputEvent subclass:#KeyboardEvent

	instanceVariableNames:'rawKey'

	classVariableNames:''

	poolDictionaries:''

	privateIn:WindowEvent

!

!WindowEvent class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1993 by Claus Gittinger

	      All Rights Reserved

 This software is furnished under a license and may be used

 only in accordance with the terms of that license and with the

 inclusion of the above copyright notice.   This software may not

 be provided or otherwise made available to, or used by, any

 other person.  No title to or ownership of the software is

 hereby transferred.

"

!

documentation

"

    Instances of WindowEvent are created for every event coming from

    the graphics device. 

    Usually, they are enqueued by the event dispatcher process into

    a sensors input queue, and dequeued & processed by a windowGroup process

    in its event loop.

    WindowEvents hold the event type and additional information (such as key,

    x/y coordinates etc). Also, windowEvents know how to send themself to some

    destination. To provide a common (single) place where event dispatching is

    implemented, this forwarding is done by a class method here (i.e. not by the

    window group itself).

    The algorithm for event dispatching is:

	- if the destination view has a keyboard focus set,

	  AND the event is a keyboard event,

	  THEN recursively invoke the event dispatching method,

	       sending the event to the focus view (or its delegate, as below)

	- if the destination view has a delegate,

	  AND its a keyboard, button or pointer event,

	  AND the delegate is interested in that event 

	      (i.e. implements & responds to #handlesXXX with true)

	  THEN send the event to the delegate, passing the original view

	       as additional argument

	- if the view has a nonNil controller,

	  AND its a key, button or pointer event,

	  THEN send the event to the controller

	- otherwise send the event to the view

    If the view has a non-nil transformation, the event is sent as a

    #deviceXXX message, passing device coordinates. Typically, subclasses

    of view do not redefine this method and the inherited default method

    translates these device coordinates into logical coordinates and resends

    an XXX message.

    If the view has no transformation, the XXX message is directly sent here.

    For example, a 'buttonPress:button x:x y:y' event leads to sending of

    'aView deviceButtonPress:button x:x y:y' which resends

    'aView buttonPress:button x:(x-logical) y:(y-logical)'

    This allows views which are interested in deviceCoordinates to get them

    (by redefining #deviceXXX) and other views to transparently get & use

    logical coordinates.

    Therefore, for a delegated keyPress messages, the flow is:

	sendEvent

	    view has delegate

		------> ask delegate via 'handlesKeyPress:key inView:view'

		<------ returns true

		------> 'delegate keyPress:key x:x y:y view:view'

			-----> delegate does whatever it wants to do

			       (typically sends the event to some other view)

    for an undelegated message:

	sendEvent

	    view has delegate

		------> ask delegate via 'handlesKeyPress:key inView:view'

		<------ returns false

	    view has controller

		------> 'controller keyPress:key x:x y:y'

	    view has no controller

		view has transformation

		    ----> 'view deviceKeyPress:key x:x y:y'

			  inverse transform x/y

			  ----> 'self keyPress:key x:xLogical y:yLogical'

		view has no transformation

		    ----> 'view keyPress:key x:x y:y'

    [author:]

	Claus Gittinger

    [see also:]

	WindowGroup WindowSensor

	DeviceWorkstation View

	KeyboardMap KeyboardForwarder EventListener

"

! !

!WindowEvent class methodsFor:'instance creation'!

damageFor:aView rectangle:aRectangle

    "create and return a new damage Event for aRectangle

     in aView"

    ^ (self new) for:aView type:#damage arguments:aRectangle

!

for:aView type:aSymbol

    "create and return a new windowEvent for sending

     aSymbol-message with no arguments to aView"

    ^ (self new) for:aView type:aSymbol arguments:#()

!

for:aView type:aSymbol arguments:argArray

    "create and return a new windowEvent for sending

     aSymbol-message with arguments to aView"

    ^ (self new) for:aView type:aSymbol arguments:argArray

! !

!WindowEvent class methodsFor:'event class access'!

buttonEvent

    "return the class used to represent buttonEvents"

    ^ ButtonEvent

    "Created: / 4.4.1997 / 13:45:04 / cg"

    "Modified: / 6.6.1998 / 21:00:29 / cg"

!

clientEvent

    "return the class used to represent clientEvents"

    ^ ClientEvent

    "Created: / 4.4.1997 / 13:58:25 / cg"

    "Modified: / 6.6.1998 / 21:00:36 / cg"

!

focusEvent

    "return the class used to represent focusEvents"

    ^ FocusEvent

    "Modified: / 6.6.1998 / 21:00:50 / cg"

    "Created: / 21.5.1999 / 19:45:25 / cg"

!

inputEvent

    "return the class used to represent inputEvents"

    ^ InputEvent

    "Created: / 13.8.1997 / 23:03:02 / cg"

    "Modified: / 6.6.1998 / 21:00:43 / cg"

!

keyboardEvent

    "return the class used to represent keyboardEvents"

    ^ KeyboardEvent

    "Created: / 4.4.1997 / 13:41:44 / cg"

    "Modified: / 6.6.1998 / 21:00:50 / cg"

! !

!WindowEvent methodsFor:'accessing'!

arguments

    "return the arguments of the event"

    ^ arguments

!

arguments:anArray

    "set the arguments"

    arguments := anArray

!

key

    "return the key - nil is returned here.

     This is redefined in KeyboardEvent."

    ^ nil

    "Created: 1.8.1997 / 13:56:21 / cg"

!

rectangle

    "return the damage rectangle"

    ^ arguments "consider this a kludge"

!

type

    "return the type of the event"

    ^ type

!

view

    "return the view, for which the event is for"

    ^ view

!

view:aView

    "set the view, for which the event is for"

    view := aView

! !

!WindowEvent methodsFor:'printing & storing'!

displayString

    "return a string for display in inspectors etc."

    ^ self className 

      , '(' , type storeString 

      , ' view: ' , view className 

      , ' args: ' , arguments displayString

      , ')'

    "Created: 7.3.1996 / 14:55:50 / cg"

    "Modified: 20.9.1997 / 11:42:11 / cg"

! !

!WindowEvent methodsFor:'private accessing'!

for:aView type:aSymbol arguments:argArray

    "set the instance variables of the event"

    view := aView.

    type := aSymbol.

    arguments := argArray

! !

!WindowEvent methodsFor:'queries'!

hasAlt

    "return true, if this is a keyboard event, with ALT pressed"

    ^ false

    "Created: 12.4.1997 / 11:04:10 / cg"

!

hasCtrl

    "return true, if this is a keyboard event, with CTRL pressed"

    ^ false

    "Created: 12.4.1997 / 11:04:03 / cg"

!

hasMeta

    "return true, if this is a keyboard event, with META pressed"

    ^ false

    "Created: 12.4.1997 / 11:04:16 / cg"

!

hasShift

    "return true, if this is a keyboard event, with SHIFT pressed"

    ^ false

    "Created: 12.4.1997 / 11:30:59 / cg"

!

isButtonEvent

    "return true, if this event is a button event"

    ^ (type == #buttonPress:x:y:) 

      or:[type == #buttonRelease:x:y:

      or:[type == #'buttonShiftPress:x:y:'

      or:[type == #'buttonMultiPress:x:y:'

      or:[type == #'buttonMotion:x:y:']]]]

!

isButtonMotionEvent

    "return true, if this event is a buttonMotion event"

    ^ (type == #buttonMotion:x:y:)

    "Created: 5.3.1997 / 12:25:43 / cg"

!

isButtonPressEvent

    "return true, if this event is a buttonPress event"

    ^ (type == #buttonPress:x:y:)

    "Created: 5.3.1997 / 12:25:43 / cg"

!

isDamage

    "return true, if this is a damage event"

    ^ type == #damage

!

isDamageForView:aView

    "return true, if this is a damage event"

    type == #damage ifTrue:[

        view == aView ifTrue:[

            ^ true

        ]

    ].

    ^ false

!

isFocusEvent

    "return true, if this event is a focusIn/focusOut event"

    ^ (type == #focusIn) or:[type == #focusOut]

    "Created: 5.3.1997 / 12:12:37 / cg"

!

isFocusInEvent

    "return true, if this event is a focusIn event"

    ^ (type == #focusIn)

    "Created: 5.3.1997 / 12:18:10 / cg"

!

isInputEvent

    "return true, if this event is an input (pointer, key or button) event"

    ^ false

    "Created: / 21.5.1999 / 19:49:42 / cg"

    "Modified: / 21.5.1999 / 19:50:11 / cg"

!

isKeyEvent

    "return true, if this event is a keyboard event"

    ^ false

    "Modified: / 28.1.1998 / 00:03:17 / cg"

!

isKeyPressEvent

    "return true, if this event is a keyboard press event"

    ^ false

    "Modified: / 28.1.1998 / 00:03:24 / cg"

!

isKeyReleaseEvent

    "return true, if this event is a keyboard release event"

    ^ false

    "Modified: / 28.1.1998 / 00:03:31 / cg"

!

isMapEvent

    "return true, if this is a map event event"

    ^ type == #mapped

    "Created: / 29.1.1998 / 21:52:54 / cg"

!

isPointerEnterEvent

    "return true, if this event is a pointer-enter event"

    ^ (type == #'pointerEnter:x:y:')

    "Created: 9.1.1996 / 15:51:24 / cg"

    "Modified: 9.1.1996 / 15:51:40 / cg"

!

isPointerEnterLeaveEvent

    "return true, if this event is a pointer-enter/leave event"

    ^ (type == #'pointerEnter:x:y:') 

      or:[type == #'pointerLeave:']

    "Created: 9.1.1996 / 15:51:18 / cg"

!

isPointerLeaveEvent

    "return true, if this event is a pointer-leave event"

    ^ type == #'pointerLeave:'

    "Created: 9.1.1996 / 15:51:36 / cg"

!

isUnmapEvent

    "return true, if this is an unmap event event"

    ^ type == #unmapped

    "Modified: / 29.1.1998 / 21:53:02 / cg"

!

isUserEvent

    "return true, if this event is a user event (i.e. mouse, keyboard or button)"

    (type == #buttonPress:x:y:) ifTrue:[^ true].

    (type == #buttonRelease:x:y:) ifTrue:[^ true].

    (type == #buttonShiftPress:x:y:) ifTrue:[^ true].

    (type == #buttonMultiPress:x:y:) ifTrue:[^ true].

    (type == #buttonMotion:x:y:) ifTrue:[^ true].

    (type == #keyPress:x:y:) ifTrue:[^ true].

    (type == #keyRelease:x:y:) ifTrue:[^ true].

    (type == #pointerEnter:x:y:) ifTrue:[^ true].

"/    (type == #pointerLeave:) ifTrue:[^ true].