"{ Encoding: utf8 }"

"{ Package: 'stx:libtool2' }"

"{ NameSpace: Smalltalk }"

Object subclass:#ShowMeHowItWorks

	instanceVariableNames:'application opStream lastComponentName lastComponent lastResult'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-Help'

!

!ShowMeHowItWorks class methodsFor:'documentation'!

documentation

"

    automatic presentations.

    To see how it works, open a methodFinder:

        MethodFinderWindow open

    and select its 'Show me how it works' item in the help menu.

    [author:]

        Claus Gittinger

"

!

example

    MethodFinderWindow open.

    ShowMeHowItWorks do:#(

        ( showing: 'Choose the number of arguments' do:(

            moveTo: NumberOfArguments

            select: '1' 

        ))  

        (showing: 'Click into the "receiver" field' do:(

            moveTo: ReceiverEditor

            click: ReceiverEditor 

        ))

        (showing: 'Enter a value (or expression) into "receiver" field' do:(

            enter: '100'

        ))

        (showing: 'Click into the "first argument" field' do:(

            moveTo: Arg1Editor

            click: ReceiverEditor

        ))

        (showing: 'Enter a value (or expression) into "receiver" field' do:(

            enter: '100'

        ))

    )

! !

!ShowMeHowItWorks class methodsFor:'running'!

do:specArray

    self doStream:specArray readStream

    "Created: / 19-07-2019 / 10:52:59 / Claus Gittinger"

    "Modified: / 19-07-2019 / 14:30:43 / Claus Gittinger"

!

doStream:specStream

    "must run as a separate process;

     otherwise - if started by the app itself -

     no events will be processed while running"

    |appWhichStartedMe|

    appWhichStartedMe := WindowGroup activeMainApplication.

    [

        self new 

            application:appWhichStartedMe;

            doStream:specStream

    ] fork.

    "Created: / 19-07-2019 / 10:53:07 / Claus Gittinger"

    "Modified: / 19-07-2019 / 16:44:02 / Claus Gittinger"

! !

!ShowMeHowItWorks methodsFor:'accessing'!

application:something

    application := something.

! !

!ShowMeHowItWorks methodsFor:'commands'!

intro

    <action>

    self tell:'you can stopp the shou - by pressing - the shiftkee'.

    "Created: / 19-07-2019 / 15:49:19 / Claus Gittinger"

!

pause

    <action>

    Dialog information:(self class classResources stringWithCRs:'Show Paused.\Click on "OK" to proceed')

    "Created: / 19-07-2019 / 15:03:17 / Claus Gittinger"

    "Modified: / 19-07-2019 / 16:13:33 / Claus Gittinger"

!

show:message

    <action>

    self showing:message do:nil

    "Created: / 19-07-2019 / 15:59:18 / Claus Gittinger"

!

showing:message do:operationsOrNothing

    <action>

    |messageView talkDone|

    self assert:(operationsOrNothing isNil or:[operationsOrNothing isSequenceable]).

    messageView := ActiveHelpView for:message.

    "/ messageView shapeStyle:#cartoon.

    [

        messageView realize.

        self talking ifTrue:[

            talkDone := Semaphore new.

            [

                self tell:message.

                talkDone signal

            ] fork.

            "/

            "/ allow speaker some headoff

            Delay waitForSeconds:(message size / 20).

        ].

        operationsOrNothing notEmptyOrNil ifTrue:[

            self doStream:(operationsOrNothing readStream).

        ].

    ] ensure:[

        messageView destroy

    ].

    self talking ifTrue:[

        talkDone wait.

    ].

    "Created: / 19-07-2019 / 11:19:27 / Claus Gittinger"

    "Modified: / 19-07-2019 / 15:59:52 / Claus Gittinger"

!

wait:seconds

    <action>

    Delay waitForSeconds:seconds

    "Created: / 19-07-2019 / 15:09:45 / Claus Gittinger"

! !

!ShowMeHowItWorks methodsFor:'commands - checking'!

isEmpty:componentName

    <action>

    |component|

    component := self componentNamed:componentName.

    component isScrollWrapper ifTrue:[ component := component scrolledView ].

    component isTextView ifTrue:[

        ^ component contents isEmptyOrNil

    ] ifFalse:[

        self halt.

    ].

    self error:'isEmpty: unhandled component type: ',component displayString.

    "Created: / 19-07-2019 / 15:33:47 / Claus Gittinger"

!

unless:query do:actions

    <action>

    |result|

    result := self doCommand:query.

    result ifFalse:[

        self doCommand:actions

    ].

    "Created: / 19-07-2019 / 15:33:32 / Claus Gittinger"

! !

!ShowMeHowItWorks methodsFor:'commands - mouse & keyboard'!

click

    "press-release"

    <action>

    ^ self click:1 inComponent:lastComponent

    "Created: / 19-07-2019 / 16:11:03 / Claus Gittinger"

!

click:buttonNr

    "press-release"

    <action>

    self assert:(buttonNr isInteger).

    ^ self click:buttonNr inComponent:lastComponent

    "Created: / 19-07-2019 / 13:21:20 / Claus Gittinger"

    "Modified: / 19-07-2019 / 16:10:19 / Claus Gittinger"

!

clickIn:componentName

    "press-release"

    <action>

    ^ self click:1 inComponent:(self componentNamed:componentName)

    "Created: / 19-07-2019 / 16:09:58 / Claus Gittinger"

!

fastMoveTo:componentName

    "move the mouse to componentName without circling"

    <action>

    |component|

    component := self componentNamed:componentName.

    self movePointerToComponent:component.

    "Created: / 19-07-2019 / 15:39:23 / Claus Gittinger"

!

moveTo:componentName

    "move the mouse to componentName,

     then circle around it a few times"

    <action>

    |component|

    component := self componentNamed:componentName.

    self movePointerToComponent:component.

    self circlePointerAroundComponent:component.

    "Created: / 19-07-2019 / 11:20:42 / Claus Gittinger"

    "Modified: / 19-07-2019 / 15:38:11 / Claus Gittinger"

!

select:itemsLabel

    "select an item by label,

     allowed after moving to:

        aComboBox

        aSelectionInListView

    "    

    <action>

    |idx|

    (lastComponent isKindOf:ComboView) ifTrue:[

        "/ click on the menubutton

        self movePointerToComponent:lastComponent menuButton.

        self click:1 inComponent:lastComponent menuButton.

        Delay waitForSeconds:0.3.

        (idx := lastComponent list indexOf:itemsLabel ifAbsent:[nil]) isNil ifTrue:[

            self error:'no such item in comboList: ',itemsLabel

        ].

        lastComponent select:idx.

        Delay waitForSeconds:0.3.

        lastComponent shownMenu notNil ifTrue:[

            lastComponent shownMenu hide.

        ].    

        ^ self

    ].    

    self error:'cannot select this component'

    "Created: / 19-07-2019 / 12:34:25 / Claus Gittinger"

    "Modified (format): / 19-07-2019 / 14:55:34 / Claus Gittinger"

!

selectIndex:itemsIndex

    "select an item by index,

     allowed after moving to:

        aComboBox

        aSelectionInListView

    "    

    <action>

    |widget y offset|

    (widget := lastComponent) isScrollWrapper ifTrue:[

        widget := widget scrolledView

    ].

    (widget isKindOf:ComboView) ifTrue:[

        "/ click on the menubutton

        self movePointerToComponent:widget menuButton.

        self click:1 inComponent:widget menuButton.

        Delay waitForSeconds:0.5.

        widget select:itemsIndex.

        Delay waitForSeconds:0.5.

self halt.

        ^ self

    ].    

    (widget isKindOf:SelectionInListView) ifTrue:[

        "/ click on the item

        y := widget yOfLine:itemsIndex.

        offset := (widget width // 2) @ y.

        self movePointerToComponent:widget offset:offset.

        widget simulateButtonPress:1 at:offset sendDisplayEvent:false.

        Delay waitForSeconds:(self clickTime).

        widget simulateButtonRelease:1 at:offset sendDisplayEvent:false.

        Delay waitForSeconds:0.5.

        ^ self

    ].    

    self error:'cannot select this component'

    "Created: / 19-07-2019 / 14:20:11 / Claus Gittinger"

    "Modified: / 19-07-2019 / 16:22:47 / Claus Gittinger"

!

type:aString

    "enter text into the last component"

    <action>

    lastComponent simulateTextInput:aString at:(lastComponent extent // 2) sendDisplayEvent:false

    "Created: / 19-07-2019 / 15:50:40 / Claus Gittinger"

! !

!ShowMeHowItWorks methodsFor:'defaults'!

circlingCount

    "circle around move-end position that many times"

    ^ 3

    "Created: / 19-07-2019 / 13:03:45 / Claus Gittinger"

!

circlingRadius 

    "radius when circling"

    ^ 30 "/ pixels

    "Created: / 19-07-2019 / 13:07:59 / Claus Gittinger"

!

circlingSpeed 

    "time per round when circling"

    ^ 0.3 seconds.       "/ time per round

    "Created: / 19-07-2019 / 13:02:34 / Claus Gittinger"

!

clickTime

    "when clicking"

    ^ self shortClickTime

    "Created: / 19-07-2019 / 13:17:20 / Claus Gittinger"

    "Modified: / 19-07-2019 / 15:21:51 / Claus Gittinger"

!

longClickTime

    "when clicking buttons"

    ^ 500 milliseconds

    "Created: / 19-07-2019 / 15:21:42 / Claus Gittinger"

!

pointerAnimationDelay

    ^ 50 milliseconds.   "/ 20 updates per second

    "Created: / 19-07-2019 / 13:04:45 / Claus Gittinger"

!

pointerMoveSpeed

    ^ 400.   "/ pixels per second

    "Created: / 19-07-2019 / 13:05:40 / Claus Gittinger"

!

shortClickTime

    "when clicking"

    ^ 100 milliseconds

    "Created: / 19-07-2019 / 15:21:29 / Claus Gittinger"

!

talking

    ^ true

    "Created: / 19-07-2019 / 14:31:14 / Claus Gittinger"

! !

!ShowMeHowItWorks methodsFor:'helper'!

componentNamed:componentName

    "retrieve a component by name or report an error if not found"

    |component|

    lastComponentName := componentName.

    component := self findComponent:componentName.

    component isNil ifTrue:[

        self error:'no component found for: ',componentName.

    ].

    lastComponent := component.

    ^ component

    "Created: / 19-07-2019 / 15:37:35 / Claus Gittinger"

!

findComponent:componentName

    "find a component by name - in the active and possibly in any app"

    |component candidates|

    application notNil ifTrue:[ 

        component := self findComponent:componentName in:application.

    ].

    component isNil ifTrue:[

        "/ search through all current applications

        candidates := OrderedCollection new.

        WindowGroup scheduledWindowGroups do:[:eachWG |

            |eachApp|

            (eachApp := eachWG application) notNil ifTrue:[

                component := self findComponent:componentName in:eachApp.

                component notNil ifTrue:[ 

                    candidates add:component

                ].

            ].

        ].

        candidates size == 1 ifTrue:[

            component := candidates first

        ] ifFalse:[    

            candidates notEmpty ifTrue:[

                self error:'multiple components found by name: ',componentName.

            ]    

        ].    

    ].    

    ^ component

    "Created: / 19-07-2019 / 12:02:30 / Claus Gittinger"

    "Modified: / 19-07-2019 / 16:44:30 / Claus Gittinger"

!

findComponent:componentName in:anApplication

    |component componentNameSymbol foundByName foundByTitle foundByLabel|

    (component := anApplication componentAt:componentName) notNil ifTrue:[^ component].

    (componentNameSymbol := componentName asSymbolIfInterned) notNil ifTrue:[

        (component := anApplication componentAt:componentNameSymbol) notNil ifTrue:[^ component].

    ].

    "/ mhmh - search through all widgets of anApplication; 

    "/ maybe it was not created via the builder/spec,

    "/ or it has changed its name.

    "/ look for: widget's name, widget's title, widget's label

    foundByName := OrderedCollection new. 

    foundByTitle := OrderedCollection new. 

    foundByLabel := OrderedCollection new.

    anApplication window allSubViewsDo:[:each |

        [

            each name = componentName ifTrue:[ foundByName add:each ].

        ] on:MessageNotUnderstood do:[:ex | ].

        [

            each title = componentName ifTrue:[ foundByTitle add:each ].

        ] on:MessageNotUnderstood do:[:ex | ].

        [

            each label = componentName ifTrue:[ foundByLabel add:each ].

        ] on:MessageNotUnderstood do:[:ex | ].

    ].

    foundByName notEmpty ifTrue:[

        self assert:(foundByName size == 1) message:'multiple components found by name'.