"

 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.

"

"{ Package: 'stx:libtool2' }"

ResourceSpecEditor subclass:#UIHelpTool

	instanceVariableNames:'classItemList classItemModel keyItemModel helpTextView

		modifiedHolder contentsModifiedChannel editModel'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-UIPainter'

!

HierarchicalItem subclass:#ClassItem

	instanceVariableNames:'theClass list modified'

	classVariableNames:''

	poolDictionaries:''

	privateIn:UIHelpTool

!

HierarchicalItem subclass:#KeyItem

	instanceVariableNames:'helpKey helpText flyByText modified icon'

	classVariableNames:''

	poolDictionaries:''

	privateIn:UIHelpTool

!

!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

	classItemList                   the list of classItems

	classItemModel                  keeps the selected class

	keyItemModel                    keeps the selected helpKey

	modifiedHolder  <ValueHolder>   true if the editField or contents changed

	editModel                       keeps the current helpKey

	helpTextView                    the view which shows the helpText

	contentsModifiedChannel         true if the helpText is modified

    [author:]

	Claus Atzkern, eXept Software AG

	Thomas Zwick,  eXept Software AG

"

! !

!UIHelpTool class methodsFor:'instance creation'!

open

    ^ self openOnClass:nil.

!

openOnClass:aClass

    "opens a Help Tool on aClass

    "

    ^ self openOnClass:aClass andSelector:#helpSpec

! !

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

resourceType

    "get the type of the resource of the method generated by the UIHelpTool"

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

#currentHelpTexts

'Selected help text key.'

#deleteHelpTextKey

'Deletes the key from the help spec.'

#fileLoad

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

#fileSave

'Saves the current help spec.'

#fileUpdate

'Reload the help spec.'

#helpTextView

'Shows the help text. Menu action ''Accept'' commits changes'

#listOfClasses

'Classes where help specs can be/are implemented.'

#listOfHelpTexts

'List of help text keys.'

#removeHelpTextKey

'Removes the help message from the widget.'

#updateHelpTextKey

'Refetch the help spec.'

)

! !

!UIHelpTool class methodsFor:'interface specs'!

innerSpec

    "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:#innerSpec

     UIHelpTool new openInterface:#innerSpec

    "

    <resource: #canvas>

    ^ 

     #(FullSpec

        name: innerSpec

        window: 

       (WindowSpec

          label: 'UIHelpTool'

          name: 'UIHelpTool'

          min: (Point 10 10)

          bounds: (Rectangle 0 0 461 293)

        )

        component: 

       (SpecCollection

          collection: (

           (VariableVerticalPanelSpec

              name: 'PanelVrt'

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

              activeHelpKey: foo

              component: 

             (SpecCollection

                collection: (

                 (VariableHorizontalPanelSpec

                    name: 'PanelHrz'

                    component: 

                   (SpecCollection

                      collection: (

                       (HierarchicalListViewSpec

                          name: 'keyItemModel'

                          model: keyItemModel

                          menu: keyItemMenu

                          hasHorizontalScrollBar: true

                          hasVerticalScrollBar: true

                          miniScrollerHorizontal: true

                          miniScrollerVertical: false

                          listModel: keyItemListHolder

                          useIndex: false

                          highlightMode: label

                          showLines: false

                          showIndicators: false

                          showLeftIndicators: false

                          useDefaultIcons: false

                          autoScrollHorizontal: false

                        )

                       (ViewSpec

                          name: 'classItemList'

                          component: 

                         (SpecCollection

                            collection: (

                             (InputFieldSpec

                                name: 'editModel'

                                layout: (LayoutFrame 0 0.0 2 0 -1 1.0 25 0)

                                activeHelpKey: currentHelpTexts

                                model: editModel

                                immediateAccept: true

                                acceptOnReturn: false

                                acceptOnTab: false

                                acceptOnLostFocus: false

                                acceptOnPointerLeave: false

                              )

                             (SelectionInListModelViewSpec

                                name: 'classItemModel'

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

                                model: classItemModel

                                hasHorizontalScrollBar: true

                                hasVerticalScrollBar: true

                                miniScrollerHorizontal: true

                                miniScrollerVertical: true

                                autoHideScrollBars: false

                                listModel: classItemListHolder

                                useIndex: false

                                highlightMode: label

                              )

                             )

                          )

                        )

                       )

                    )

                    handles: (Any 0.607375 1.0)

                  )

                 (ArbitraryComponentSpec

                    name: 'helpTextView'

                    hasHorizontalScrollBar: true

                    hasVerticalScrollBar: true

                    miniScrollerHorizontal: true

                    miniScrollerVertical: true

                    hasBorder: false

                    component: helpTextView

                  )

                 )

              )

              handles: (Any 0.679181 1.0)

            )

           )

        )

      )

!

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

        name: windowSpec

        window: 

       (WindowSpec

          label: 'Help Tool'

          name: 'Help Tool'

          min: (Point 300 300)

          bounds: (Rectangle 0 0 498 429)

          menu: menu

        )

        component: 

       (SpecCollection

          collection: (

           (ViewSpec

              name: 'mainPanel'

              layout: (LayoutFrame 0 0.0 0 0.0 0 1.0 -24 1.0)

              component: 

             (SpecCollection

                collection: (

                 (UISubSpecification

                    name: 'innerSpec'

                    layout: (LayoutFrame 0 0.0 0 0.0 0 1.0 -24 1.0)

                    minorKey: innerSpec

                  )

                 (UISubSpecification

                    name: 'windowSpecForCommit'

                    layout: (LayoutFrame 0 0.0 -24 1.0 0 1.0 0 1.0)

                    majorKey: ToolApplicationModel

                    minorKey: windowSpecForCommit

                  )

                 )

              )

            )

           (UISubSpecification

              name: 'infoBarSubSpec'

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

              majorKey: ToolApplicationModel

              minorKey: windowSpecForInfoBar

            )

           )

        )

      )

! !

!UIHelpTool class methodsFor:'menu specs'!

helpTextMenu

    "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:#helpTextMenu

     (Menu new fromLiteralArrayEncoding:(UIHelpTool helpTextMenu)) startUp

    "

    <resource: #menu>

    ^ 

     #(#Menu

	#(

	 #(#MenuItem

	    #activeHelpKey: #commitOK

	    #enabled: #contentsModifiedChannel

	    #label: 'Accept'

	    #itemValue: #accept

	    #translateLabel: true

	  )

	 #(#MenuItem

	    #activeHelpKey: #commitCancel

	    #enabled: #contentsModifiedChannel

	    #label: 'Cancel'

	    #itemValue: #cancel

	    #translateLabel: true

	  )

	 )

	nil

	nil

      )

!

keyItemMenu

    "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:#keyItemMenu

     (Menu new fromLiteralArrayEncoding:(UIHelpTool keyItemMenu)) startUp

    "

    <resource: #menu>

    ^ 

     #(#Menu

	#(

	 #(#MenuItem

	    #activeHelpKey: #deleteHelpTextKey

	    #label: 'Delete'

	    #itemValue: #doDelete

	    #translateLabel: true

	  )

	 )

	nil

	nil

      )

!

listOfKeysMenu

    "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:#listOfKeysMenu

     (Menu new fromLiteralArrayEncoding:(UIHelpTool listOfKeysMenu)) startUp

    "

    <resource: #menu>

    ^ 

     #(#Menu

	#(

	 #(#MenuItem

	    #activeHelpKey: #deleteHelpTextKey

	    #label: 'Delete'

	    #itemValue: #doDelete

	    #translateLabel: true

	  )

	 )

	nil

	nil

      )

!

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'

            translateLabel: true

            submenu: 

           (Menu

              (

               (MenuItem

                  label: 'New'

                  itemValue: doNew

                  translateLabel: true

                )

               (MenuItem

                  label: '-'

                )

               (MenuItem

                  activeHelpKey: fileLoad

                  label: 'Load...'

                  itemValue: doLoad

                  translateLabel: true

                )

               (MenuItem

                  activeHelpKey: fileSave

                  label: 'Save'

                  itemValue: doSave

                  translateLabel: true

                )

               (MenuItem

                  label: '-'

                  isVisible: isStandAlone

                )

               (MenuItem

                  activeHelpKey: fileExit

                  label: 'Exit'

                  itemValue: closeRequest

                  translateLabel: true

                  isVisible: isStandAlone

                )