"

 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.

"

ToolApplicationModel subclass:#UIHelpTool

	instanceVariableNames:'specClass specSelector dictionary dictionaries listSelection

		maxCharsPerLine modifiedHolder modified'

	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 Help Tool allows you to define help dictionaries for the widgets in

    window 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.

    [instance variables:]

        specClass       <Symbol>        class implementing the help spec

        specSelector    <Symbol>        selector returning the help spec

        dictionary      <Dictionary>    dictionary containing pairs of help keys/texts

        dictionaries    <Dictionary>    dictionary containing pairs of help spec classes/help dictionaries

        listSelection   <String>        current selected help key

        maxCharsPerLine <Integer>       maximum number of allowed characters per text line

        modifiedHolder  <ValueHolder>   value holder for setting as modified

        modified        <Boolean>       flag whether the help spec was modified

    [author:]

        Claus Atzkern, eXept Software AG

        Thomas Zwick, eXept Software AG

"

! !

!UIHelpTool class methodsFor:'instance creation'!

openOnClass:aClass

    "opens a Help Tool on aClass"

    "

     UIHelpTool openOnClass:self

    "

    UIHelpTool new openOnClass:aClass

! !

!UIHelpTool class methodsFor:'constants'!

label

    "returns the label; used if embedded as sub canvas in the GUI Painter or Menu Editor"

    ^'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 the help text key to the help spec.'

#currentHelpTexts

'Selected help text key.'

#deleteHelpTextKey

'Deletes the help text key from the help spec.'

#fileLoad

'Opens a dialog for selecting and loading a help spec from a class.'

#fileSave

'Saves current 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 155 0 273 0 440 0 543 0)

              #label: 'Help Tool'

              #min: #(#Point 10 10)

              #max: #(#Point 1160 870)

              #bounds: #(#Rectangle 155 273 441 544)

              #usePreferredExtent: false

          )

          #component: 

           #(#SpecCollection

              #collection: 

               #(

                 #(#VariableVerticalPanelSpec

                    #name: 'VariableVerticalPanel'

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

                    #component: 

                     #(#SpecCollection

                        #collection: 

                         #(

                           #(#VariableHorizontalPanelSpec

                              #name: 'VariableHorizontalPanel'

                              #component: 

                               #(#SpecCollection

                                  #collection: 

                                   #(

                                     #(#SequenceViewSpec

                                        #name: 'listOfHelpKeysView'

                                        #activeHelpKey: #listOfHelpTexts

                                        #tabable: true

                                        #model: #listModel

                                        #hasHorizontalScrollBar: true

                                        #hasVerticalScrollBar: true

                                        #miniScrollerHorizontal: true

                                        #useIndex: false

                                        #sequenceList: #listChannel

                                    )

                                     #(#ViewSpec

                                        #name: 'Box'

                                        #component: 

                                         #(#SpecCollection

                                            #collection: 

                                             #(

                                               #(#InputFieldSpec

                                                  #name: 'helpKeyInputField'

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

                                                  #activeHelpKey: #currentHelpTexts

                                                  #tabable: true

                                                  #model: #listModel

                                                  #immediateAccept: false

                                              )

                                               #(#SequenceViewSpec

                                                  #name: 'listOfHelpSpecClassesView'

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

                                                  #activeHelpKey: #listOfHelpSpecClasses

                                                  #tabable: true

                                                  #model: #selectionOfHelpSpecClass

                                                  #hasHorizontalScrollBar: true

                                                  #hasVerticalScrollBar: true

                                                  #miniScrollerHorizontal: true

                                                  #miniScrollerVertical: true

                                                  #valueChangeSelector: #helpSpecClassSelected

                                                  #useIndex: false

                                                  #sequenceList: #listOfHelpSpecClasses

                                              )

                                               #(#HorizontalPanelViewSpec

                                                  #name: 'HorizontalPanel1'

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

                                                  #component: 

                                                   #(#SpecCollection

                                                      #collection: 

                                                       #(

                                                         #(#ActionButtonSpec

                                                            #name: 'AddButton'

                                                            #activeHelpKey: #addHelpTextKey

                                                            #label: 'Add'

                                                            #tabable: true

                                                            #model: #doAdd

                                                            #extent: #(#Point 44 24)

                                                        )

                                                         #(#ActionButtonSpec

                                                            #name: 'RemoveButton'

                                                            #activeHelpKey: #removeHelpTextKey

                                                            #label: 'Remove'

                                                            #tabable: true

                                                            #model: #doRemove

                                                            #extent: #(#Point 45 24)

                                                        )

                                                         #(#ActionButtonSpec

                                                            #name: 'DeleteButton'

                                                            #activeHelpKey: #deleteHelpTextKey

                                                            #label: 'Delete'

                                                            #tabable: true

                                                            #model: #doDelete

                                                            #extent: #(#Point 45 24)

                                                        )

                                                      )

                                                  )

                                                  #horizontalLayout: #fit

                                                  #verticalLayout: #fit

                                                  #horizontalSpace: 3

                                                  #verticalSpace: 3

                                              )

                                            )

                                        )

                                    )

                                  )

                              )

                              #handles: #(#Any 0.5 1.0)

                          )

                           #(#TextEditorSpec

                              #name: 'helpTextView'

                              #activeHelpKey: #helpTextView

                              #tabable: true

                              #hasHorizontalScrollBar: true

                              #hasVerticalScrollBar: true

                              #miniScrollerHorizontal: true

                              #miniScrollerVertical: true

                          )

                        )

                    )

                    #handles: #(#Any 0.5 1.0)

                )

              )

          )

      )

!

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 191 0 334 0 660 0 663 0)

              #label: 'Help Tool'

              #min: #(#Point 300 300)

              #max: #(#Point 1152 900)

              #bounds: #(#Rectangle 191 334 661 664)

              #menu: #menu

              #usePreferredExtent: false

          )

          #component: 

           #(#SpecCollection

              #collection: 

               #(

                 #(#UISubSpecification

                    #name: 'windowSpec'

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

                    #minorKey: #windowSpec

                )

                 #(#UISubSpecification

                    #name: 'windowSpecForInfoBar'

                    #layout: #(#LayoutFrame 0 0 -24 1 0 1 0 1)

                    #majorKey: #ToolApplicationModel

                    #minorKey: #windowSpecForInfoBar

                )

              )

          )

      )

! !

!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: 'Load'

                          #value: #doLoad

                          #activeHelpKey: #fileLoad

                      )

                       #(#MenuItem

                          #label: '-'

                      )

                       #(#MenuItem

                          #label: 'Save'

                          #value: #doSave

                          #activeHelpKey: #fileSave

                      )

                       #(#MenuItem

                          #label: '-'

                      )

                       #(#MenuItem

                          #label: 'Exit'

                          #value: #closeRequest

                          #activeHelpKey: #fileExit

                      )

                    ) nil

                    nil

                )

            )

             #(#MenuItem

                #label: 'Edit'

                #submenu: 

                 #(#Menu

                     #(

                       #(#MenuItem

                          #label: 'Add'

                          #value: #doAdd

                          #activeHelpKey: #addHelpTextKey

                      )

                       #(#MenuItem

                          #label: '-'

                      )

                       #(#MenuItem

                          #label: 'Delete'

                          #value: #doDelete

                          #activeHelpKey: #deleteHelpTextKey

                      )

                    ) nil

                    nil

                )

            )

             #(#MenuItem

                #label: 'Help'

                #startGroup: #right

                #submenu: 

                 #(#Menu

                     #(

                       #(#MenuItem

                          #label: 'Documentation'

                          #value: #openHTMLDocument:

                          #activeHelpKey: #helpHelpTool

                          #argument: 'tools/uipainter/HelpTool.html'

                      )

                       #(#MenuItem

                          #label: '-'

                      )

                       #(#MenuItem

                          #label: 'Show Help Texts'

                          #activeHelpKey: #helpShowHelp

                          #indication: #showHelp:

                      )

                    ) nil

                    nil

                )

            )

          ) nil

          nil

      )

! !

!UIHelpTool methodsFor:'accessing'!

dictionaries

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

    ^dictionaries

!

dictionaries:aDictionaryOfDictionaries

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

    (dictionaries := aDictionaryOfDictionaries) isNil ifTrue:[

        dictionaries := Dictionary new.

    ].

    self updateList.

!

dictionary

    "returns the dictionary of the selected class"

    ^dictionary

!

dictionary:aDictionary

    "sets dictionary of the selected class"

    (dictionary := aDictionary) isNil ifTrue:[

        dictionary := Dictionary new.

    ].

    self updateList

!

helpKey

    "returns the help key of selected help text"

    listSelection size ~~ 0 ifTrue:[

        ^ listSelection asSymbol

    ].

    ^ nil

!

helpKey:aKey

    "sets 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

!

modified

    "returns whether the help tool was modified"