PointFromUserController.st
author Claus Gittinger <cg@exept.de>
Thu, 09 Nov 2017 20:09:30 +0100
changeset 6225 0122e4e6c587
parent 6143 5324a89d3400
permissions -rw-r--r--
#FEATURE by cg class: GenericToolbarIconLibrary class added: #hideFilter16x16Icon
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6121
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     1
"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     2
 COPYRIGHT (c) 2017 by eXept Software AG
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
              All Rights Reserved
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
 This software is furnished under a license and may be used
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
 only in accordance with the terms of that license and with the
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
 be provided or otherwise made available to, or used by, any
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
 other person.  No title to or ownership of the software is
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
 hereby transferred.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
"{ Package: 'stx:libwidg' }"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    14
"{ NameSpace: Smalltalk }"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    15
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    16
ButtonController subclass:#PointFromUserController
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    17
	instanceVariableNames:'action pressPoint'
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    18
	classVariableNames:''
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    19
	poolDictionaries:''
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    20
	category:'Interface-Support-Controllers'
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    21
!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    22
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    23
!PointFromUserController class methodsFor:'documentation'!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    24
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    25
copyright
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    26
"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    27
 COPYRIGHT (c) 2017 by eXept Software AG
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    28
              All Rights Reserved
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    29
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    30
 This software is furnished under a license and may be used
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    31
 only in accordance with the terms of that license and with the
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    32
 inclusion of the above copyright notice.   This software may not
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
 be provided or otherwise made available to, or used by, any
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
 other person.  No title to or ownership of the software is
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
 hereby transferred.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
documentation
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
    drags a rectangle.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
    An instance of me can be installed temporarily as controller of any view,
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
    to let the user select a rectangular area from the view.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
    Use the utility method:
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
        dragRectangleIn:aView thenDo:action
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
    which does exactly that for your (and cares to restore any original controller)    
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
    
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
examples
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
    |v c|
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
    v := View new openAndWait.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
    c := PointFromuserController new.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
    c action:[:point | Transcript showCR:point ].
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
    v openAndWait.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
    
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
    v controller:c.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
! !
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    65
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    66
!PointFromUserController class methodsFor:'utilities'!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
pointFromUserIn:aView thenDo:action
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
    "wait for a button press in aView"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
    
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    71
    |pickController oldController oldCursor|
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
    
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
    pickController := self new.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
    pickController view:aView.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    75
    oldController := aView controller.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    76
    oldCursor := aView cursor.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    77
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    78
    aView cursor:Cursor crossHair.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
    pickController action:[:pointOrNil |
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
        |image|
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    82
        aView controller:oldController.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    83
        aView cursor:oldCursor.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    84
        action value:pointOrNil.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    85
    ].
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    86
    
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
    aView controller:pickController.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
    "Created: / 07-03-2017 / 18:29:28 / cg"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    90
! !
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    91
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    92
!PointFromUserController methodsFor:'accessing'!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    93
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    94
action:aBlock
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    95
    "set the block which will be called when the point has been picked.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    96
     The block will be called with a nil arg, if escape is pressed"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    97
     
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    98
    action := aBlock
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    99
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   100
    "Modified (comment): / 07-03-2017 / 18:26:34 / cg"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   101
!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   102
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   103
pressPoint
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   104
    ^ pressPoint
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   105
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   106
    "Created: / 07-03-2017 / 18:28:36 / cg"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   107
! !
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   108
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   109
!PointFromUserController methodsFor:'event handling'!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   110
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   111
buttonPress:button x:x y:y
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   112
    pressPoint := x@y.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   113
    view cursor:(Cursor normal).
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   114
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   115
    "Modified: / 07-03-2017 / 18:27:46 / cg"
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   116
!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   117
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   118
buttonRelease:button x:x y:y
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   119
    |point|
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   120
    
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   121
    pressPoint isNil ifTrue:[
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   122
        super buttonRelease:button x:x y:y.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   123
        ^ self
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   124
    ].
6143
5324a89d3400 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 6121
diff changeset
   125
    
6121
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   126
    point := pressPoint.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   127
    pressPoint := nil.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   128
    action value:point.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   129
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   130
    "Modified: / 07-03-2017 / 18:28:24 / cg"
6143
5324a89d3400 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 6121
diff changeset
   131
    "Modified (format): / 10-04-2017 / 08:41:13 / cg"
6121
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   132
!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   133
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   134
keyPress:key x:x y:y
6143
5324a89d3400 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 6121
diff changeset
   135
    "actually, this is for the escape key (to abort a drag operation)"
5324a89d3400 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 6121
diff changeset
   136
6121
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   137
    pressPoint isNil ifTrue:[
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   138
        super keyPress:key x:x y:y.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   139
        ^ self
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   140
    ].
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   141
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   142
    pressPoint := nil.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   143
    action value:nil.
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   144
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   145
    "Modified: / 07-03-2017 / 18:27:19 / cg"
6143
5324a89d3400 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 6121
diff changeset
   146
    "Modified (comment): / 10-04-2017 / 08:41:08 / cg"
6121
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   147
! !
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   148
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   149
!PointFromUserController class methodsFor:'documentation'!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   150
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   151
version
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   152
    ^ '$Header$'
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   153
!
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   154
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   155
version_CVS
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   156
    ^ '$Header$'
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   157
! !
7fb5e8886804 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   158