"

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

"

ApplicationModel subclass:#UIHelpTool

	instanceVariableNames:'specClass dictionary dictionaries listSelection modified

		modifiedHolder maxCharsPerLine'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-UIPainter'

!

!UIHelpTool class methodsFor:'documentation'!

copyright

"

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

"

!

documentation

"

    The UIHelpTool allows you to define help dictionaries for the widgets in

    applications. The tool are able to run stand alone or in other master 

    applications like the GUI Painter and the Menu Editor.

    If the application responds to the selector #showHelp:aHelpText for:aView,

    this selector is called by the widget's view when the mouse cursor moves over. 

    If the application does not responds to that selector, and the activeHelp mode

    is enabled, an active help bubble is shown at the widget's view.

    [author:]

        Claus Atzkern

"

! !

!UIHelpTool class methodsFor:'instance creation'!

openOnClass:aClass

    "

     UIHelpTool openOnClass:UIPainter

    "

    UIHelpTool open helpSpecFrom:aClass

! !

!UIHelpTool class methodsFor:'constants'!

label

    ^'Help'

! !

!UIHelpTool class methodsFor:'help specs'!

helpSpec

    "This resource specification was automatically generated

     by the UIHelpTool of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the UIHelpTool may not be able to read the specification."

    "

     UIHelpTool openOnClass:UIHelpTool    

    "

    <resource: #help>

    ^super helpSpec addPairsFrom:#(

#addHelpTextKey

'Adds help text key.'

#currentHelpTexts

'Selected help text key.'

#deleteHelpTextKey

'Deletes the help text from the help spec.'

#helpTextView

'Shows the help text.'

#listOfHelpSpecClasses

'List of the classes where help specs can be/are implemented.'

#listOfHelpTexts

'List of the help text keys.'

#removeHelpTextKey

'Removes the help text key from the widget.'

)

! !

!UIHelpTool class methodsFor:'interface specs'!

windowSpec

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the UIPainter may not be able to read the specification."

    "

     UIPainter new openOnClass:UIHelpTool andSelector:#windowSpec

     UIHelpTool new openInterface:#windowSpec

     UIHelpTool open

    "

    <resource: #canvas>

    ^

       #(#FullSpec

          #window: 

           #(#WindowSpec

              #name: 'Help Tool'

              #layout: #(#LayoutFrame 140 0 231 0 425 0 501 0)

              #label: 'Help Tool'

              #min: #(#Point 10 10)

              #max: #(#Point 1160 870)

              #bounds: #(#Rectangle 140 231 426 502)

              #usePreferredExtent: false

          )

          #component: 

           #(#SpecCollection

              #collection: 

               #(

                 #(#SequenceViewSpec

                    #name: 'listOfHelpKeysView'

                    #layout: #(#LayoutFrame 3 0 2 0 -1 0.5 -1 0.5)

                    #activeHelpKey: #listOfHelpTexts

                    #tabable: true

                    #model: #listModel

                    #hasHorizontalScrollBar: true

                    #hasVerticalScrollBar: true

                    #miniScrollerHorizontal: true

                    #useIndex: false

                    #sequenceList: #listChannel

                )

                 #(#ActionButtonSpec

                    #name: 'AddButton'

                    #layout: #(#LayoutFrame 2 0.5 2 0 -1 0.67 26 0)

                    #activeHelpKey: #addHelpTextKey

                    #label: 'Add'

                    #tabable: true

                    #model: #add

                )

                 #(#ActionButtonSpec

                    #name: 'RemoveButton'

                    #layout: #(#LayoutFrame 1 0.67 2 0 -1 0.83 26 0)

                    #activeHelpKey: #removeHelpTextKey

                    #label: 'Remove'

                    #tabable: true

                    #model: #remove

                )

                 #(#ActionButtonSpec

                    #name: 'DeleteButton'

                    #layout: #(#LayoutFrame 1 0.83 2 0 -2 1 26 0)

                    #activeHelpKey: #deleteHelpTextKey

                    #label: 'Delete'

                    #tabable: true

                    #model: #delete

                )

                 #(#InputFieldSpec

                    #name: 'helpKeyInputField'

                    #layout: #(#LayoutFrame 1 0.5 29 0 -3 1 51 0)

                    #activeHelpKey: #currentHelpTexts

                    #tabable: true

                    #model: #listModel

                    #immediateAccept: false

                )

                 #(#SequenceViewSpec

                    #name: 'listOfHelpSpecClassesView'

                    #layout: #(#LayoutFrame 1 0.5 54 0 -3 1 -1 0.5)

                    #activeHelpKey: #listOfHelpSpecClasses

                    #tabable: true

                    #model: #selectionOfHelpSpecClass

                    #hasHorizontalScrollBar: true

                    #hasVerticalScrollBar: true

                    #miniScrollerHorizontal: true

                    #miniScrollerVertical: true

                    #valueChangeSelector: #helpSpecClassSelected

                    #useIndex: false

                    #sequenceList: #listOfHelpSpecClasses

                )

                 #(#TextEditorSpec

                    #name: 'helpTextView'

                    #layout: #(#LayoutFrame 3 0.0 1 0.5 -1 1.0 -3 1.0)

                    #activeHelpKey: #helpTextView

                    #tabable: true

                    #hasHorizontalScrollBar: true

                    #hasVerticalScrollBar: true

                    #miniScrollerHorizontal: true

                    #miniScrollerVertical: true

                )

              )

          )

      )

!

windowSpecForStandAlone

    "This resource specification was automatically generated

     by the UIPainter of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the UIPainter may not be able to read the specification."

    "

     UIPainter new openOnClass:UIHelpTool andSelector:#windowSpecForStandAlone

     UIHelpTool new openInterface:#windowSpecForStandAlone

    "

    <resource: #canvas>

    ^

       #(#FullSpec

          #window: 

           #(#WindowSpec

              #name: 'Help Tool'

              #layout: #(#LayoutFrame 534 0 276 0 1033 0 675 0)

              #label: 'Help Tool'

              #min: #(#Point 10 10)

              #max: #(#Point 1160 870)

              #bounds: #(#Rectangle 534 276 1034 676)

              #menu: #menu

              #usePreferredExtent: false

          )

          #component: 

           #(#SpecCollection

              #collection: 

               #(

                 #(#UISubSpecification

                    #name: 'UISubSpecification1'

                    #layout: #(#LayoutFrame 0 0.0 0 0.0 0 1.0 0 1.0)

                    #minorKey: #windowSpec

                )

              )

          )

      )

! !

!UIHelpTool class methodsFor:'menu specs'!

menu

    "This resource specification was automatically generated

     by the MenuEditor of ST/X."

    "Do not manually edit this!! If it is corrupted,

     the MenuEditor may not be able to read the specification."

    "

     MenuEditor new openOnClass:UIHelpTool andSelector:#menu

     (Menu new fromLiteralArrayEncoding:(UIHelpTool menu)) startUp

    "

    <resource: #menu>

    ^

       #(#Menu

           #(

             #(#MenuItem

                #label: 'File'

                #submenu: 

                 #(#Menu

                     #(

                       #(#MenuItem

                          #label: 'Reload'

                          #value: #doReload

                      )

                       #(#MenuItem

                          #label: '-'

                      )

                       #(#MenuItem

                          #label: 'Save'

                          #value: #doSave

                      )

                       #(#MenuItem

                          #label: '-'

                      )

                       #(#MenuItem

                          #label: 'Define Class...'

                          #value: #doFromClass

                      )

                       #(#MenuItem

                          #label: '-'

                      )

                       #(#MenuItem

                          #label: 'Exit'

                          #value: #closeRequest

                      )

                    ) nil

                    nil

                )

            )

          ) nil

          nil

      )

! !

!UIHelpTool methodsFor:'accessing'!

dictionaries

    "get the dictionary of the help dictionaries of the classes having help specs

    "

    ^dictionaries

!

dictionaries:aDictionaryOfDictionaries

    "set a dictionary of the help dictionaries of the classes having help specs

    "

    (dictionaries := aDictionaryOfDictionaries) isNil ifTrue:[

        dictionaries := Dictionary new.

    ].

    self updateList.

!

dictionary

    "get the dictionary of the selected class

    "

    ^dictionary

!

dictionary:aDictionary

    "set dictionary of the selected class

    "

    (dictionary := aDictionary) isNil ifTrue:[

        dictionary := Dictionary new.

    ].

    self updateList

!

helpKey

    "get the help key of selected help text

    "

    listSelection size ~~ 0 ifTrue:[

        ^ listSelection asSymbol

    ].

    ^ nil

!

helpKey:aKey

    "set the help key into the selection channel in order to show the help text

    "

    |key|

    aKey size ~~ 0 ifTrue:[

        key := aKey asString

    ].

    self listModel value:key

!

helpSpecFrom:aClass

    "read the help dictionary from aClass and find remaining classes 

     'between' aClass and ApplicationModel 

    "

    |help|

    modified := false.

    specClass notNil

    ifTrue:

    [   

        dictionary   := Dictionary new.

        dictionaries := Dictionary new.

    ].

    specClass  := self applicationClassAssociatedWith:aClass.

    (specClass isClass and: [specClass isLoaded])

    ifTrue: 

    [                                               

        (specClass class implements:#helpSpec) ifFalse:[

            dictionaries at: specClass name put: dictionary 

        ].

        self listOfHelpSpecClasses contents:  (specClass withAllSuperclasses reverse collect: [:cls| cls name]).

        (self listOfHelpSpecClasses includes: #ApplicationModel)

            ifTrue: [self listOfHelpSpecClasses removeAll: (ApplicationModel withAllSuperclasses collect: [:cls| cls name])].

        self selectionOfHelpSpecClass value: specClass name. 

        (builder componentAt: #listOfHelpSpecClassesView) selection: 

                (self listOfHelpSpecClasses value indexOf: specClass name).

        self helpSpecClassSelected.

    ].

    self updateList

!

modified

    "answer whether the help tool was modified

    "

    ^modified

!

modified: aBoolean

    "set the help tool as modified

    "

    modified := aBoolean

!

modifiedHolder:aValueHolder

    "set the value holder set to true in case of modifying attributes

    "

    modifiedHolder notNil ifTrue:[

        modifiedHolder removeDependent:self. 

    ].

    (modifiedHolder := aValueHolder) notNil ifTrue:[

        modifiedHolder addDependent:self.

        self editTextView notNil ifTrue: [

            self editTextView modifiedChannel onChangeSend:#value to:[

                modifiedHolder notNil ifTrue:[

                    self editTextView modifiedChannel value ifTrue:[

                        modifiedHolder value:true

                    ]

                ]

            ]

        ]

    ]

!

specClass

    "get the class on which the help tool works

    "

    ^specClass

! !

!UIHelpTool methodsFor:'aspects'!

listChannel

    "get the value holder of the help texts

    "

    |holder|

    (holder := builder bindingAt:#listChannel) isNil ifTrue:[

        builder aspectAt:#listChannel put:(holder :=  OrderedCollection new asValue).

    ].

    ^ holder

!

listModel

    "get the value holder of the help key

    "

    |holder|

    (holder := builder bindingAt:#listModel) isNil ifTrue:[

        holder := AspectAdaptor new subject:self; forAspect:#listSelection.

        builder aspectAt:#listModel put:holder.

    ].

    ^ holder

!

listOfHelpSpecClasses

    "get the value holder of the specClass and its superclasses 

     which are subclasses of ApplicationModel

    "

    |holder|

    (holder := builder bindingAt:#listOfHelpSpecClasses) isNil ifTrue:[

        builder aspectAt:#listOfHelpSpecClasses put: (holder := List new)

    ].

    ^ holder

!

selectionOfHelpSpecClass

    "get the value holder of the selected help spec class

    "

    |holder|