"

 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:'isModified specClass dictionary dictionaries listSelection

		maxCharsPerLine modifiedHolder'

	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

"

    used by the UIPainter to add help text to any component which will be shown

    during runing an application with enabled activeHelp mode.

    [author:]

        Claus Atzkern

"

! !

!UIHelpTool class methodsFor:'instance creation'!

openOnClass:aClass

    "

     UIHelpTool openOnClass:UIPainter

    "

    |helpTool|

    helpTool := UIHelpTool open.

    helpTool helpSpecFrom:aClass.

    helpTool dictionary: aClass helpSpec.

! !

!UIHelpTool class methodsFor:'constants'!

label

    ^'Help'

! !

!UIHelpTool class methodsFor:'help specs'!

helpSpec

    "return a dictionary filled with helpKey -> helptext associations.

     These are used by the activeHelp tool."

    "

    UIHelpTool openOnClass:UIHelpTool    

    "

  ^ 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 window spec was automatically generated by the ST/X UIPainter"

    "do not manually edit this - the painter/builder may not be able to

     handle the specification if its corrupted."

    "

     UIPainter new openOnClass:UIHelpTool andSelector:#windowSpec

     UIHelpTool new openInterface:#windowSpec

    "

    "UIHelpTool open"

    <resource: #canvas>

    ^

       #(#FullSpec

          #window: 

           #(#WindowSpec

              #name: 'unnamed canvas'

              #layout: #(#LayoutFrame 118 0 430 0 403 0 700 0)

              #label: 'unnamed canvas'

              #min: #(#Point 10 10)

              #max: #(#Point 1160 870)

              #bounds: #(#Rectangle 118 430 404 701)

              #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

                )

                 #(#HorizontalPanelViewSpec

                    #name: 'HorizontalPanelView'

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

                    #component: 

                     #(#SpecCollection

                        #collection: 

                         #(

                           #(#ActionButtonSpec

                              #name: 'AddButton'

                              #activeHelpKey: #addHelpTextKey

                              #label: 'Add'

                              #model: #add

                              #extent: #(#Point 44 24)

                          )

                           #(#ActionButtonSpec

                              #name: 'RemoveButton'

                              #activeHelpKey: #removeHelpTextKey

                              #label: 'Remove'

                              #model: #remove

                              #extent: #(#Point 44 24)

                          )

                           #(#ActionButtonSpec

                              #name: 'DeleteButton'

                              #activeHelpKey: #deleteHelpTextKey

                              #label: 'Delete'

                              #model: #delete

                              #extent: #(#Point 45 24)

                          )

                        )

                    )

                    #horizontalLayout: #fit

                    #verticalLayout: #fit

                    #horizontalSpace: 3

                    #verticalSpace: 3

                )

                 #(#InputFieldSpec

                    #name: 'helpKeyInputField'

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

                    #activeHelpKey: #currentHelpTexts

                    #model: #listModel

                    #immediateAccept: false

                )

                 #(#SequenceViewSpec

                    #name: 'listOfHelpSpecClassesView'

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

                    #activeHelpKey: #listOfHelpSpecClasses

                    #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

                    #hasHorizontalScrollBar: true

                    #hasVerticalScrollBar: true

                    #miniScrollerHorizontal: true

                    #miniScrollerVertical: true

                )

              )

          )

      )

!

windowSpecForStandAlone

    "this window spec was automatically generated by the ST/X UIPainter"

    "do not manually edit this - the painter/builder may not be able to

     handle the specification if its corrupted."

    "

     UIPainter new openOnClass:UIHelpTool andSelector:#windowSpecForStandAlone

     UIHelpTool new openInterface:#windowSpecForStandAlone

    "

    <resource: #canvas>

    ^

       #(#FullSpec

          #window: 

           #(#WindowSpec

              #name: 'Help Tool'

              #layout: #(#LayoutFrame 195 0 352 0 694 0 751 0)

              #label: 'Help Tool'

              #min: #(#Point 10 10)

              #max: #(#Point 1160 870)

              #bounds: #(#Rectangle 195 352 695 752)

              #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 window spec was automatically generated by the ST/X MenuEditor"

    "do not manually edit this - the builder may not be able to

     handle the specification if its corrupted."

    "

     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|

    isModified := 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

!

isModified

    "answer whether the help tool was modified

    "

    ^isModified

!

isModified: aBoolean

    "set the help tool as modified

    "

    isModified := 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:'actions'!

helpSpecClassSelected

    "extract the help dictionary from the selected class and make it current

    "

    |clsName|

    clsName := self selectionOfHelpSpecClass value.

    (dictionary := dictionaries at: clsName ifAbsent: nil) isNil

    ifTrue:

    [        

        dictionary := dictionaries at: clsName put: (self extractHelpSpecForClass: (Smalltalk at: clsName))

    ].

    self updateList.

    listSelection notNil

    ifTrue: 

    [

        (dictionary keys includes: listSelection asSymbol)

            ifTrue: [(builder componentAt: #listOfHelpKeysView) selection: 

                     (self listChannel value indexOf: (builder componentAt: #helpKeyInputField) contents)]

            ifFalse: [(builder componentAt: #listOfHelpKeysView) selection: nil].

    ].

    listSelection notNil

    ifTrue: 

    [

        self editTextView contents: (dictionary at: listSelection asSymbol ifAbsent: '')

    ]

!

installHelpSpecOnClass:aClass

    "save the help dicts in aClass which is subclass of ApplicationModel"

    |cls src helpSpec|

    cls := self applicationClassAssociatedWith:aClass.

    cls isNil ifTrue:[