hg/stx-libview: comparison WindowEvent.st

equal deleted inserted replaced

-:0df4950e6214
+:d0233524dfd8
 other person.  No title to or ownership of the software is
 hereby transferred.
 "
 "{ Package: 'stx:libview' }"
+"{ NameSpace: Smalltalk }"
 Event subclass:#WindowEvent
 	instanceVariableNames:'delegatedFrom consumed'
 	classVariableNames:''
 	poolDictionaries:''
 	category:'Interface-Support-UI'
 	poolDictionaries:''
 	privateIn:WindowEvent
 !
 WindowEvent::InputEvent subclass:#KeyboardEvent
-	instanceVariableNames:'rawKey'
+	instanceVariableNames:'untranslatedKey rawKey isDeadKey'
 	classVariableNames:''
 	poolDictionaries:''
 	privateIn:WindowEvent
 !
 	poolDictionaries:''
 	privateIn:WindowEvent
 !
 WindowEvent subclass:#MessageSendEvent
-	instanceVariableNames:''
+	instanceVariableNames:'generatedBy'
-	classVariableNames:''
+	classVariableNames:'Debug'
 	poolDictionaries:''
 	privateIn:WindowEvent
 !
 WindowEvent::ButtonEvent subclass:#MouseWheelMotionEvent
-	instanceVariableNames:''
+	instanceVariableNames:'repeatCount'
 	classVariableNames:''
 	poolDictionaries:''
 	privateIn:WindowEvent
 !
 	privateIn:WindowEvent
 !
 WindowEvent subclass:#VisibilityChangeEvent
 	instanceVariableNames:'visibility'
+	classVariableNames:''
+	poolDictionaries:''
+	privateIn:WindowEvent
+!
+WindowEvent subclass:#WidgetSelectionEvent
+	instanceVariableNames:''
 	classVariableNames:''
 	poolDictionaries:''
 	privateIn:WindowEvent
 !
 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
+a sensor's 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
 hotkeyWithId:aHotkeyId rawKey:keyWithModifier view:aView
 |ev|
 ev := (HotKeyEvent new)
 for:aView
 type:#hotkeyWithId:rawKey:
 arguments:(Array with:keyWithModifier with:0 with:0).
 ev rawKey:keyWithModifier.
 ev hotkeyIdentifier:aHotkeyId.
 ^ ev
 !
 x:x y:y view:aView
 |ev|
 ev := self keyPress:key x:x y:y view:aView.
-ev rawKey:untranslatedKey.
+ev rawKey:untranslatedKey untranslatedKey:untranslatedKey.
 ev  hasShift:shiftDown ctrl:ctrlDown alt:altDown meta:metaDown
 button1:leftButtonDown button2:middleButtonDown button3:rightButtonDown.
 ^ ev
 !
 x:x y:y view:aView
 |ev|
 ev := self keyRelease:key x:x y:y view:aView.
-ev rawKey:untranslatedKey.
+ev rawKey:untranslatedKey untranslatedKey:untranslatedKey.
 ev  hasShift:shiftDown ctrl:ctrlDown alt:altDown meta:metaDown
 button1:leftButtonDown button2:middleButtonDown button3:rightButtonDown.
 ^ ev
 !
 for:aView
 type:#mapped
 !
 messageSend:receiver selector:aSelector arguments:arguments
-^ MessageSendEvent
+"create and return a new messageSend for sending
-for:receiver
+aSelector-message with arguments to receiver.
-type:aSelector
+Usually, these are placed into the eventQueue, to ensure synchronized operation of change-update notifications"
-arguments:arguments
+^ MessageSendEvent for:receiver type:aSelector arguments:arguments
 !
 mouseWheelMotion:state x:x y:y amount:amount deltaTime:deltaTime view:aView
 ^ MouseWheelMotionEvent
 for:aView
 arguments:(Array with:how).
 "Created: / 23-01-2012 / 09:51:03 / cg"
 ! !
+!WindowEvent class methodsFor:'class access'!
+buttonMotionEvent
+^ ButtonMotionEvent
+"Created: / 13-02-2019 / 12:55:25 / Claus Gittinger"
+!
+buttonPressEvent
+^ ButtonPressEvent
+"Created: / 13-02-2019 / 12:54:38 / Claus Gittinger"
+!
+buttonReleaseEvent
+^ ButtonReleaseEvent
+"Created: / 13-02-2019 / 12:54:31 / Claus Gittinger"
+! !
 !WindowEvent class methodsFor:'constants'!
 dropType_directory
 ^ #directory
 for:aView type:aSymbol
 "create and return a new windowEvent for sending
 aSymbol-message with no arguments to aView"
+self == WindowEvent ifTrue:[
+'----------------' errorPrint.
+'WindowEvent is abstract - use/add explicit creation message' errorPrintCR.
+thisContext fullPrintAll.
+self abstractClassInstantiationError.
+].
 ^ self new for:aView type:aSymbol
 !
 for:aView type:aSymbol arguments:argArray
 "create and return a new windowEvent for sending
 aSymbol-message with arguments to aView"
+self == WindowEvent ifTrue:[
+'----------------' errorPrint.
+'WindowEvent is abstract - use/add explicit creation message' errorPrintCR.
+thisContext fullPrintAll.
+self abstractClassInstantiationError.
+].
 ^ self new for:aView type:aSymbol arguments:argArray
 !
 new
 self == WindowEvent ifTrue:[
 "return the value of the instance variable 'delegatedFrom' (automatically generated)"
 ^ delegatedFrom
 !
-delegatedFrom:something
+delegatedFrom:someOne
 "set the value of the instance variable 'delegatedFrom' (automatically generated)"
-delegatedFrom := something.
+delegatedFrom := someOne.
 !
 key
 "return the key - nil is returned here.
 This is redefined in KeyboardEvent."
 !
 dispatchWithViewArgumentTo:anObject
 "send this event to anObject, and pass an additional view argument"
-args size = 0 ifTrue:[
+args size == 0 ifTrue:[
 ^ anObject
 perform:selector asMutator
 with:receiver
 ].
 !WindowEvent methodsFor:'printing & storing'!
 displayOn:aGCOrStream
 "Compatibility
 append a printed desription on some stream (Dolphin,  Squeak)
 OR:
 display the receiver in a graphicsContext at 0@0 (ST80).
 This method allows for any object to be displayed in some view
 (although the fallBack is to display its printString ...)"
 "/ what a kludge - Dolphin and Squeak mean: printOn: a stream;
-"/ ST/X (and some old ST80's) mean: draw-yourself on a GC.
+"/ old ST80 means: draw-yourself on a GC.
 aGCOrStream isStream ifFalse:[
 ^ super displayOn:aGCOrStream.
 ].
 aGCOrStream
-nextPutAll:self class name;
+nextPutAll:self className;
 nextPut:$(.
 selector storeOn:aGCOrStream.
 aGCOrStream
 nextPutAll:' view: ';
 nextPutAll:' args: '.
 args displayOn:aGCOrStream.
 aGCOrStream nextPut:$)
-"Created: 7.3.1996 / 14:55:50 / cg"
+"Created: / 07-03-1996 / 14:55:50 / cg"
-"Modified: 20.9.1997 / 11:42:11 / cg"
+"Modified: / 20-09-1997 / 11:42:11 / cg"
+"Modified (comment): / 22-02-2017 / 16:53:02 / cg"
+"Modified: / 28-06-2019 / 09:23:38 / Claus Gittinger"
 ! !
 !WindowEvent methodsFor:'private-accessing'!
 for:aView type:aSymbol
 !
 isUserEvent
 "return true, if this event is a user event (i.e. mouse, keyboard or button)"
-self isButtonEvent       ifTrue:[^ true].
+^ false
-self isKeyEvent          ifTrue:[^ true].
-self isTerminateEvent    ifTrue:[^ true].
+"Modified: / 05-03-1997 / 11:27:40 / cg"
+"Modified: / 16-03-2018 / 11:07:59 / stefan"
-self isPointerEnterEvent ifTrue:[^ true].
-"/ self isPointerLeaveEvent ifTrue:[^ true].     -- why disabled ?
-^ false
-"Modified: 5.3.1997 / 11:27:40 / cg"
 ! !
 !WindowEvent::ApplicationEvent methodsFor:'blocked'!
 view
 "return true, if this event is a button event"
 ^ true
 "Created: 4.4.1997 / 13:44:11 / cg"
+!
+isUserEvent
+"return true, if this event from a user"
+^ true
+"Created: / 16-03-2018 / 11:05:26 / stefan"
 ! !
 !WindowEvent::ButtonPressEvent methodsFor:'testing'!
 isButtonPressEvent
 "return true, if this event is a pointer-leave event"
 ^ selector == #'pointerLeave:'
 "Created: 9.1.1996 / 15:51:36 / cg"
+!
+isUserEvent
+"return true, if this event from a user"
+^ self isPointerEnterEvent
+"why not true for pointerLeave?"
+"Created: / 16-03-2018 / 11:07:04 / stefan"
 ! !
 !WindowEvent::FocusEvent methodsFor:'testing'!
 isFocusEvent
 ^ (selector == #focusOut)
 "Created: / 21.5.1999 / 19:45:04 / cg"
 ! !
+!WindowEvent::KeyboardEvent class methodsFor:'documentation'!
+documentation
+"
+documentation to be added.
+class:
+<a short class summary here, describing what instances represent>
+responsibilities:
+<describing what my main role is>
+collaborators:
+<describing with whom and how I talk to>
+API:
+<public api and main messages>
+example:
+<a one-line examples on how to use - can also be in a separate example method>
+implementation:
+<implementation points>
+[author:]
+exept MBP
+[instance variables:]
+[class variables:]
+[see also:]
+"
+! !
 !WindowEvent::KeyboardEvent methodsFor:'accessing'!
+isDeadKey:aBoolean
+"set (by the sensor) if this is an event for a deadKey.
+Consumers may want to mark deadKeys specially
+(eg. by highlighting it, as done in the editTextView)"
+isDeadKey := aBoolean
+"Created: 4.4.1997 / 13:47:15 / cg"
+!
 key
-"return the key of the key-event."
+"return the (translated) key of the key-event.
+i.e. if the keyboardMap maps #Ctrlc to #Copy,
+then key will be #Copy and untranslatedKey will be #Ctrlc
+and rawKey will be $c."
 ^ args at:1
 "Created: 1.8.1997 / 13:55:19 / cg"
 !
 key:aCharacterOrSymbol
-"change the key of the key-event."
+"set the (translated) key of the key-event.
+i.e. if the keyboardMap maps #Ctrlc to #Copy,
+then key will be #Copy and untranslatedKey will be #Ctrlc
+and rawKey will be $c."
 args at:1 put:aCharacterOrSymbol
 "Created: 1.8.1997 / 13:55:19 / cg"
 !
 rawKey
+"return the (raw) key of the key-event.
+i.e. if the keyboardMap maps #Ctrlc to #Copy,
+then key will be #Copy and untranslatedKey will be #Ctrlc
+and rawKey will be $c."
+rawKey isNil ifTrue:[^ self key].
 ^ rawKey
 "Created: 4.4.1997 / 13:47:15 / cg"
 !
 rawKey:aKey
+"set the (raw) key of the key-event.
+i.e. if the keyboardMap maps #Ctrlc to #Copy,
+then key will be #Copy and untranslatedKey will be #Ctrlc
+and rawKey will be $c."
 rawKey := aKey
+"Created: 4.4.1997 / 13:47:10 / cg"
+!
+rawKey:rKey untranslatedKey:uKey
+"set the (raw) key of the key-event.
+i.e. if the keyboardMap maps #Ctrlc to #Copy,
+then key will be #Copy and untranslatedKey will be #Ctrlc
+and rawKey will be $c."
+rawKey := rKey.
+untranslatedKey := uKey.
+"Created: 4.4.1997 / 13:47:10 / cg"
+!
+untranslatedKey
+"return the untranslated key of the key-event;
+i.e. if the keyboardMap maps #Ctrlc to #Copy,
+then key will be #Copy and untranslatedKey will be #Ctrlc
+(and rawKey will be $c)."
+untranslatedKey isNil ifTrue:[^ self key].
+^ untranslatedKey
+"Created: 4.4.1997 / 13:47:15 / cg"
+!
+untranslatedKey:aKey
+"set the untranslated key of the key-event.
+i.e. if the keyboardMap maps #Ctrlc to #Copy,
+then key will be #Copy and untranslatedKey will be #Ctrlc
+and rawKey will be $c."
+untranslatedKey := aKey
 "Created: 4.4.1997 / 13:47:10 / cg"
 !
 x
 ^ args at:3 put:anInteger
 ! !
 !WindowEvent::KeyboardEvent methodsFor:'testing'!
+isDeadKey
+"return true, if this event is for a deadKey"
+^ isDeadKey ? false
+!
 isDelegatedToFocusView
 "return true, if this event will be forwarded to a focusView."
 ^ true
 !
 "return true, if this event is a keyboard event"
 ^ true
 "Created: 4.4.1997 / 13:39:59 / cg"
+!
+isUserEvent
+"return true, if this event from a user"
+^ true
+"Created: / 16-03-2018 / 11:05:50 / stefan"
 ! !
 !WindowEvent::ButtonMotionEvent methodsFor:'testing'!
 isButtonMotionEvent
 "return true, if this event is a keyboard focus event"
 ^ true
 ! !
+!WindowEvent::MessageSendEvent class methodsFor:'documentation'!
+documentation
+"
+documentation to be added.
+class:
+<a short class summary here, describing what instances represent>
+responsibilities:
+<describing what my main role is>
+collaborators:
+<describing with whom and how I talk to>
+API:
+<public api and main messages>
+example:
+<a one-line examples on how to use - can also be in a separate example method>
+implementation:
+<implementation points>
+[author:]
+cg
+[instance variables:]
+[class variables:]
+[see also:]
+"
+! !
+!WindowEvent::MessageSendEvent class methodsFor:'instance creation-basic'!
+for:aView type:aSymbol
+"create and return a new windowEvent for sending
+aSymbol-message with no arguments to aView"
+^ (super for:aView type:aSymbol) rememberSender
+!
+for:aView type:aSymbol arguments:argArray
+"create and return a new windowEvent for sending
+aSymbol-message with arguments to aView"
+^ (super for:aView type:aSymbol arguments:argArray) rememberSender
+! !
+!WindowEvent::MessageSendEvent methodsFor:'accessing'!
+rememberSender
+"possibly (i.e if Debug is true) remember the context where the message was generated.
+Somewhat heuristicly skip uninterresting contexts."
+|con|
+(Debug ? false) ifFalse:[^ self].
+con := thisContext sender.
+[
+con notNil
+and:[ (con receiver == self)
+or:[(con receiver == self class)
+or:[(con receiver == WindowEvent)
+or:[(con receiver class == WindowSensor)
+or:[(con receiver class == RecursionLock)
+or:[(con receiver isBlock)
+or:[(con selector == #enqueueMessage:for:arguments:)
+or:[(con selector == #enqueueMessage:for:)
+]]]]]]]
+]
+] whileTrue:[
+con := con sender.
+].
+generatedBy := con.
+! !
 !WindowEvent::MessageSendEvent methodsFor:'blocked'!
 view
 ^ nil
 ! !
 ! !
+!WindowEvent::MouseWheelMotionEvent class methodsFor:'documentation'!
+documentation
+"
+documentation to be added.
+class:
+<a short class summary here, describing what instances represent>
+responsibilities:
+<describing what my main role is>
+collaborators:
+<describing with whom and how I talk to>
+API:
+<public api and main messages>
+example:
+<a one-line examples on how to use - can also be in a separate example method>
+implementation:
+<implementation points>
+[author:]
+exept MBP
+[instance variables:]
+[class variables:]
+[see also:]
+"
+! !
 !WindowEvent::MouseWheelMotionEvent methodsFor:'accessing'!
+addAmount:moreAmount
+"used to compress multiple mouse-wheel motions into one"
+args at:4 put:(args at:4) + moreAmount
+!
 amount
 "return the amount of the mouse wheel motion event   "
 ^ args at:4
 deltaTime
 "return the deltaTime of the mouse wheel motion event   "
 ^ args at:5
+!
+incrementRepeatCount
+repeatCount := (repeatCount ? 0) + 1.
+!
+repeatCount
+"used to compress multiple mouse-wheel motions into one"
+^ repeatCount ? 1
 ! !
 !WindowEvent::MouseWheelMotionEvent methodsFor:'testing'!
 isDelegatedToFocusView
 !WindowEvent::TerminateEvent methodsFor:'testing'!
 isTerminateEvent
 ^ true
+!
+isUserEvent
+"return true, if this event from a user"
+^ true
+"Created: / 16-03-2018 / 11:06:05 / stefan"
 ! !
 !WindowEvent::TrayActionEvent methodsFor:'accessing'!
 event
 ^ self new
 "Created: / 23-01-2012 / 10:02:42 / cg"
 ! !
+!WindowEvent::WidgetSelectionEvent class methodsFor:'documentation'!
+copyright
+"
+COPYRIGHT (c) 2008 by eXept Software AG
+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.
+"
+! !
+!WindowEvent::WidgetSelectionEvent methodsFor:'accessing'!
+widget:aWidget
+selector := #'widgetSelected:'.
+args := Array with:aWidget class name.
+receiver := aWidget.
+timeStamp := Timestamp now.
+!
+widgetClassName
+^ args at: 1
+! !
 !WindowEvent::WindowMapUnmapEvent methodsFor:'testing'!
 isMapEvent
 "return true, if this is a map event"
 ! !
 !WindowEvent class methodsFor:'documentation'!
 version_CVS
+^ '$Header$'
-^  '$Header: /cvs/stx/stx/libview/WindowEvent.st,v 1.111 2014-03-05 22:13:18 cg Exp $'
 !
 version_SVN
 ^ '$ Id $'
 ! !

branch	jv
changeset 9049	d0233524dfd8
parent 6312	fd183f4f73b5