hg/stx-libtool2: comparison UIHelpTool.st

equal deleted inserted replaced

-:ec4d0d1605c5
+:8e0d01180c6e
+"{ Encoding: utf8 }"
 "
 COPYRIGHT (c) 1995 by eXept Software AG
 	      All Rights Reserved
 This software is furnished under a license and may be used
 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
+#(Menu
-	#(
+(
-	 #(#MenuItem
+(MenuItem
-	    #activeHelpKey: #commitOK
+activeHelpKey: commitOK
-	    #enabled: #contentsModifiedChannel
+enabled: contentsModifiedChannel
-	    #label: 'Accept'
+label: 'Accept'
-	    #itemValue: #accept
+itemValue: accept
-	    #translateLabel: true
+)
-	  )
+(MenuItem
-	 #(#MenuItem
+activeHelpKey: commitCancel
-	    #activeHelpKey: #commitCancel
+enabled: contentsModifiedChannel
-	    #enabled: #contentsModifiedChannel
+label: 'Cancel'
-	    #label: 'Cancel'
+itemValue: cancel
-	    #itemValue: #cancel
+)
-	    #translateLabel: true
+)
-	  )
+nil
-	 )
+nil
-	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
+#(Menu
-	#(
+(
-	 #(#MenuItem
+(MenuItem
-	    #activeHelpKey: #deleteHelpTextKey
+activeHelpKey: deleteHelpTextKey
-	    #label: 'Delete'
+enabled: hasKeyItemSelectedHolder
-	    #itemValue: #doDelete
+label: 'Delete Key'
-	    #translateLabel: true
+itemValue: doDelete
-	  )
+)
-	 )
+(MenuItem
-	nil
+label: '-'
-	nil
+)
+(MenuItem
+activeHelpKey: extractHelpTextKeys
+label: 'Extract used Keys from Application'
+itemValue: doExtractUsedKeys
+enabled: hasSpecClassDefined
+)
+)
+nil
+nil
 )
+"Modified: / 24-05-2018 / 15:52:24 / Claus Gittinger"
 !
 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
+#(Menu
-	#(
+(
-	 #(#MenuItem
+(MenuItem
-	    #activeHelpKey: #deleteHelpTextKey
+activeHelpKey: deleteHelpTextKey
-	    #label: 'Delete'
+label: 'Delete'
-	    #itemValue: #doDelete
+itemValue: doDelete
-	    #translateLabel: true
+)
-	  )
+)
-	 )
+nil
-	nil
+nil
-	nil
 )
 !
 menu
 "This resource specification was automatically generated
 ^ masterApplication enablingCommitButtonsHolder
 ].
 ^ contentsModifiedChannel
 !
+hasKeyItemSelectedHolder
+^ BlockValue
+with:[:m | m notNil]
+argument:self keyItemModel
+"Created: / 24-05-2018 / 15:48:51 / Claus Gittinger"
+!
+hasSpecClassDefined
+^ [ specClass notNil ]
+"Created: / 24-05-2018 / 15:52:09 / Claus Gittinger"
+!
 helpTextView
 "the editView which shows the current help contents assigned to the key
 "
 ^ helpTextView
 !
 !UIHelpTool methodsFor:'change & update'!
 editModelChanged
 "called if the editModel changed
-"
+cg: so does anyone think, that a comment like the above is useful?
+this is called when the text in the edit field (which selects the current key)
+is changed."
 |key|
 key := self helpKey.
 modifiedHolder notNil ifTrue:[
 "
 self enablingCommitButtonsHolder value:true.
 ].
 ].
 keyItemModel value:nil.
+"Modified (comment): / 24-05-2018 / 16:17:16 / Claus Gittinger"
 !
 update:something with:aParameter from:changedObject
 "Invoked when an object that I depend upon sends a change notification.
 "
 ! !
 !UIHelpTool methodsFor:'user actions'!
 accept
-"accepts the help text
+"accepts the help text;
-"
+take the contents of the helpTextView and store it under the current helpKey"
-|helpKey helpItem root|
+|helpKey|
 helpKey := self helpKey.
 helpKey isNil ifTrue:[^ self].
-root := classItemModel value.
+self store:(helpTextView contents) forKey:helpKey
-root isNil ifTrue:[^ self].
+"Modified: / 24-05-2018 / 16:31:25 / Claus Gittinger"
-helpItem := root detectItemWithKey:helpKey.
-helpItem isNil ifTrue:[
-helpItem := KeyItem helpKey:helpKey helpText:(helpTextView contents).
-root add:helpItem sortBlock:[:a :b| a label < b label ].
-self updateIcons.
-] ifFalse:[
-helpItem helpText:(helpTextView contents).
-].
-contentsModifiedChannel value:false.
-keyItemModel triggerValue:helpItem.
 !
 cancel
 "cancel modifications, reload helpText"
 item notNil ifTrue:[
 item remove.
 item icon notNil ifTrue:[ self updateIcons ].
 ].
 editModel value:nil.
+!
+doExtractUsedKeys
+"goes through the classes menu- and interface specs,
+and extracts possible activeHelpKeys"
+|allHelpKeys existingKeys cls missingKeys|
+allHelpKeys := Set new.
+specClass theMetaclass methodsDo:[:mthd |
+|spec bodyNode retVal specArray menu|
+(mthd hasMenuResource or:[mthd hasCanvasResource]) ifTrue:[
+bodyNode := mthd parseTree body.
+bodyNode lastIsReturn ifTrue:[
+(retVal := bodyNode statements last value) isLiteralArray ifTrue:[
+specArray := retVal value.
+spec := specArray decodeAsLiteralArray.
+spec do:[:eachSpec |
+|k|
+(k := eachSpec activeHelpKey) notNil ifTrue:[
+allHelpKeys add:k.
+].
+].
+]
+].
+].
+].
+existingKeys := Set new.
+(cls := specClass theMetaclass whichClassImplements:self specSelector) notNil ifTrue:[
+|specThere|
+specThere := cls theNonMetaclass perform:self specSelector.
+specThere isDictionary ifFalse:[
+Transcript showCR:('oops - helpSpec from ',cls name,'>>',self specSelector,' is not a dictionary').
+] ifTrue:[
+existingKeys addAll:(specThere keys).
+].
+].
+missingKeys := OrderedCollection new.
+allHelpKeys do:[:each |
+(existingKeys includes:each) ifFalse:[
+missingKeys add:each.
+].
+].
+missingKeys do:[:eachKey |
+self store:'no tooltip yet' forKey:eachKey
+].
+"Created: / 24-05-2018 / 16:00:08 / Claus Gittinger"
 !
 doLoad
 "opens a Resource Selection Browser in order to get a resource message"
 specClass isNil ifTrue:[
 self information:'No class specified !!'.
 ^ nil
 ].
-"/ cg: the following test is rubbish !!
-"/    (specClass isSubclassOf:ApplicationModel) ifFalse:[
+"/ cg: the following test is rubbish !!
-"/        self information:(resources string:'Cannot save help into non-Application class').
+"/    (specClass isSubclassOf:ApplicationModel) ifFalse:[
-"/        ^ nil
+"/        self information:(resources string:'Cannot save help into non-Application class').
-"/    ].
+"/        ^ nil
+"/    ].
 classItemList do:[:aClassItem|
 aClassItem theClass isNil ifTrue:[
 aClassItem onClass:specClass
 ].
 aClassItem createHelpMethodNamed:(self specSelector)
 ].
+"Modified (format): / 24-05-2018 / 16:25:31 / Claus Gittinger"
 !
 openDocumentation
 "opens the documentation file of the Help Tool
 "
 self openHTMLDocument: 'tools/uipainter/HelpTool.html'
+!
+store:helpText forKey:helpKey
+"store helpText under helpKey"
+|helpItem root|
+root := classItemModel value.
+root isNil ifTrue:[^ self].
+helpItem := root detectItemWithKey:helpKey.
+helpItem isNil ifTrue:[
+helpItem := KeyItem helpKey:helpKey helpText:helpText.
+root add:helpItem sortBlock:[:a :b| a label < b label ].
+self updateIcons.
+] ifFalse:[
+helpItem helpText:(helpTextView contents).
+].
+contentsModifiedChannel value:false.
+keyItemModel triggerValue:helpItem.
+"Created: / 24-05-2018 / 16:31:08 / Claus Gittinger"
 ! !
 !UIHelpTool::ClassItem class methodsFor:'instance creation'!
 onClass:aClass

changeset 3560	8e0d01180c6e
parent 3542	96a0b064685f
child 3810	d4f7c137ffc4