"

 COPYRIGHT (c) 1990 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.

"

StandardSystemView subclass:#ModalBox

       instanceVariableNames:'shadowView exclusiveKeyboard '

       classVariableNames:'UseTransientViews'

       poolDictionaries:''

       category:'Views-Basic'

!

ModalBox comment:'

COPYRIGHT (c) 1990 by Claus Gittinger

	      All Rights Reserved

'!

!ModalBox class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1990 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.

"

!

version

"

"

!

documentation

"

    this class implements modal boxes; ModalBoxes are different from

    others, in that they take control over the current topview, until 

    all processing is done (i.e. the currently active topview and all of

    its subviews will not handle user events while the box is active).

    ModalBoxes are either implemented as transient windows

    (if UseTransientViews := true) or as override redirect views.

    Some window managers have problems with either; so you may want to

    change the default setting from your display.rc file.

"

! !

!ModalBox class methodsFor:'initialization'!

initialize

    UseTransientViews := true.

! !

!ModalBox class methodsFor:'defaults'!

defaultExtent

    "this defines the defaultExtent for instances of me;

     the value returned here is usually not correct for concrete subclasses,

     so you better redefine this method"

    ^ (Display pixelPerMillimeter * (60 @ 30)) rounded

!

useTransientViews:aBoolean 

    "change the way modalBoxes are created on the Display.

     If the argument is true, transient views are used; otherwise

     override redirect views are used. Depending on your windowmanager,

     either one may have problems. You may want to change the setting

     from your display.rc or d_xxx.rc file."

    UseTransientViews := aBoolean.

    "

     ModalBox useTransient:false

     ModalBox useTransient:true 

    "

! !

!ModalBox methodsFor:'initialize / release'!

initialize

    |form resizeButton moveButton|

    super initialize.

    exclusiveKeyboard := false.

    label := ' '.

    label := 'Popup'.

    UseTransientViews ifFalse:[

	(StyleSheet at:#popupShadow default:false) ifTrue:[

	    shadowView := (ShadowView on:device) for:self

	].

	form := Form width:8 height:8 

		     fromArray:#[2r00000000

				 2r00000000 

				 2r00000000 

				 2r00000001

				 2r00000011

				 2r00000111 

				 2r00001111

				 2r00011111 

				]

		     on:device.

	resizeButton := Button form:form in:self.

	resizeButton origin:1.0 @ 1.0 corner:1.0@1.0.

	resizeButton activeForegroundColor:(resizeButton foregroundColor).

	resizeButton activeBackgroundColor:(resizeButton backgroundColor).

	resizeButton enteredBackgroundColor:(resizeButton backgroundColor).

	resizeButton leftInset:-8; topInset:-8.

	resizeButton releaseAction:[].

	resizeButton pressAction:[resizeButton turnOff; redraw. self doResize].

	resizeButton borderWidth:0.

	resizeButton onLevel:0; offLevel:0.

	resizeButton cursor:(Cursor corner).

	form := Form width:8 height:8 

		     fromArray:#[2r11111000

				 2r11110000 

				 2r11100000 

				 2r11000000

				 2r10000000

				 2r00000000 

				 2r00000000

				 2r00000000 

				]

		     on:device.

	moveButton := Button form:form in:self.

	moveButton origin:0.0 @ 0.0 corner:0.0@0.0.

	moveButton activeForegroundColor:(moveButton foregroundColor).

	moveButton activeBackgroundColor:(moveButton backgroundColor).

	moveButton enteredBackgroundColor:(moveButton backgroundColor).

	moveButton rightInset:-8; bottomInset:-8.

	moveButton releaseAction:[].

	moveButton pressAction:[moveButton turnOff; redraw. self doMove].

	moveButton borderWidth:0.

	moveButton onLevel:0; offLevel:0.

	moveButton cursor:(Cursor origin)

    ].

!

initEvents

    super initEvents.

    self enableEvent:#visibilityChange

!

initStyle

    super initStyle.

    ((style ~~ #normal) and:[style ~~ #mswindows]) ifTrue:[

	borderWidth := 0.

	UseTransientViews ifFalse:[

	    self level:2

	]

    ]

!

reinitialize

   super reinitialize.

   self unrealize.

!

addToCurrentProject

    "ignored here"

    ^ self

!

destroy

    shadowView notNil ifTrue:[

	shadowView destroy.

	shadowView := nil

    ].

    self leaveControl. "just to make sure"

    super destroy.

!

create

    super create.

    shadowView notNil ifTrue:[

	self saveUnder:true

    ]

!

createOnTop

    ^ UseTransientViews not

!

resize

    "resize myself to make everything visible"

    |newExtent|

    newExtent := self preferedExtent.

    newExtent = self extent ifTrue:[^ self].

    (shown and:[shadowView notNil]) ifTrue:[

	shadowView unrealize.

	self extent:newExtent.

	shadowView realize.

	self raise

    ] ifFalse:[

	self extent:newExtent.

    ].

! !

!ModalBox methodsFor:'queries'!

preferedExtent

    "return the extent required to make all components

     visible in myself. This should be redefined in

     subclasses."

    ^ self class defaultExtent

! !

!ModalBox methodsFor:'accessing'!

exclusiveKeyboard:aBoolean

    "set/clear exclusive locking of the keyboard;

     If set, the box will take total control over the

     keyboard, not allowing input to other views/boxes

     while active.

     Danger: only use this for very very urgent boxes, since

     no interaction with any view on the screen is possible then."

    exclusiveKeyboard := aBoolean

! !

!ModalBox methodsFor:'show / hide'!

mapped

    "wait till visible for grabbing"

    super mapped.

    "take it away from any popup menu possibly still active"

    device ungrabKeyboard.

    device ungrabPointer.

    "

     if I am a super-modal box, take the keyboard

    "

    exclusiveKeyboard ifTrue:[

	device grabKeyboardInView:self.

    ].

"/    UseTransientViews ifFalse:[

	"

	 get the focus

	"

	self getKeyboardFocus.

	self enableEnterLeaveEvents

"/    ]

!

fixPosition:aPoint

    "set origin to aPoint, but make sure, that the box is fully visible 

     by shifting it into the visible screen area if nescessary.

     This prevents invisible modalBoxes (which you could never close)."

    self origin:aPoint.

    self makeFullyVisible

!

positionOffset

    "return the delta, by which the box should be

     displaced from the mouse pointer. 

     Usually redefined in subclasses to have the most convenient

     ok-button appear under the pointer."

    ^ (width // 2) @ (height // 2)

!

open

    "default for modalboxes is to come up modal at the pointer position"

    ^ self showAtPointer

!

openModal:aBlock

    "open the box modal;

     In addition to the basic (inherited) modalloop, change

     the current active windowgroups cursors to the busy-stop cursor, show

     a shadow, and raise the box."

    |mainGroup mainView useTransient|

    useTransient := UseTransientViews.

    "

     show a stop-cursor in the current group

    "

    mainGroup := WindowGroup activeGroup.

    mainGroup notNil ifTrue:[

	mainGroup := mainGroup mainGroup.

	mainGroup notNil ifTrue:[

	    mainGroup showCursor:(Cursor stop).

	]

    ].

    mainGroup isNil ifTrue:[

	useTransient := false

    ].

    useTransient ifTrue:[

	mainGroup topViews notNil ifTrue:[

	    mainView := mainGroup topViews first.

	].

	mainView isNil ifTrue:[

	    useTransient := false.

	]

    ].

    useTransient ifTrue:[

	shadowView := nil.

    ] ifFalse:[

	shadowView notNil ifTrue:[shadowView realize].

    ].

    self raise.

    mainGroup notNil ifTrue:[

	"

	 flush pending key & mouse events.

	 this avoids pre-characters 

	 to be put into the view ...

	"

"/        mainGroup sensor flushUserEvents.

    ].

    useTransient ifTrue:[

	device setTransient:drawableId for:(mainView id).

    ].

    super openModal:aBlock.

    mainGroup notNil ifTrue:[

	"

	 flush any key & mouse events which arrived

	 while the box was open (avoids stray input).

	"

	mainGroup sensor flushUserEvents.

    ].

!

show

    "make myself visible (at the last or default position) and take control"

    self fixSize.

    self makeFullyVisible.

    self openModal

    "

     |b|

     b := InfoBox title:'hello'.

     b show.

    "

!

showAt:aPoint

    "make myself visible at aPoint.

     Fix position to make box fully visible"

    self fixSize.

    self fixPosition:aPoint.

    self openModal

    "

     |b|

     b := InfoBox title:'hello'.

     b showAt:(0 @ 0).

     b showAt:(400 @ 400).

    "

!

showAt:aPoint center:center

    "make myself visible at aPoint. center specifies

     if the view should show up centered around aPoint."

    self showAt:aPoint centerX:center centerY:center

    "

     |b|

     b := InfoBox title:'hello'.

     b showAt:(100 @ 100) center:true.

     b showAt:(100 @ 100) center:false.

    "

!

showAt:aPoint centerX:centerX centerY:centerY

    "make myself visible at aPoint. centerX/centerY specify

     if the view should show up centered around aPoint.

     Fix position to make box fully visible"

    |dx dy|

    self fixSize.

    centerX ifTrue:[

	dx := self width // 2.

    ] ifFalse:[

	dx := 0

    ].

    centerY ifTrue:[

	dy := self height // 2.

    ] ifFalse:[

	dy := 0

    ].

    self origin:(aPoint - (dx @ dy)).

    self makeFullyVisible.

    self openModal

    "

     |b|

     b := InfoBox title:'hello'.

     b showAt:(100 @ 100).

     b showAt:(100 @ 100) centerX:true centerY:false.

    "

!

showAtCenter

    "make myself visible at the screen center."

    self showAt:(device center) center:true

    "

     |b|

     b := InfoBox title:'hello'.

     b showAtCenter.

    "

!

showCenteredIn:aView

    "make myself visible at the screen center."

    |top|

    top := aView topView.

    top raise.

    self showAt:(top center + (aView originRelativeTo:top)) center:true

    "

     |b|

     b := InfoBox title:'hello'.

     b showCenteredIn:Transcript.

    "

!

showAtPointer

    "make myself visible at mouse pointer shifted to have

     convenient button under cursor. self positionOffset should

     return that offset (usually redefined, since we dont know here,

     which button should be under cursor)."

    self fixSize.

    self fixPosition:(device pointerPosition - self positionOffset).

    self openModal

    "

     |b|

     b := InfoBox title:'hello'.

     b showAtPointer.

    "