#DOCUMENTATION by cg
class: UIHelpTool
added: #flyByHelpSpec
removed: #helpSpec
comment/format in:
#helpKey
#helpTextView
changed: #windowSpec
--- a/UIHelpTool.st Wed May 04 22:39:03 2016 +0200
+++ b/UIHelpTool.st Thu May 05 20:46:35 2016 +0200
@@ -108,7 +108,7 @@
!UIHelpTool class methodsFor:'help specs'!
-helpSpec
+flyByHelpSpec
"This resource specification was automatically generated
by the UIHelpTool of ST/X."
@@ -121,7 +121,7 @@
<resource: #help>
- ^ super helpSpec addPairsFrom:#(
+ ^ super flyByHelpSpec addPairsFrom:#(
#addHelpTextKey
'Adds the key to the help spec.'
@@ -290,50 +290,50 @@
<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
- )
+ #(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: 'infoBarSubSpec'
- layout: (LayoutFrame 0 0 -24 1 0 1 0 1)
- majorKey: ToolApplicationModel
- minorKey: windowSpecForInfoBar
- )
+ (UISubSpecification
+ name: 'windowSpecForCommit'
+ layout: (LayoutFrame 0 0.0 -30 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'!
@@ -519,15 +519,15 @@
!UIHelpTool methodsFor:'accessing'!
helpKey
- "returns the helpKey as symbol or nil
+ "returns the helpKey (symbol) or nil
"
|key|
key := editModel value.
key size ~~ 0 ifTrue:[
- key := key withoutSeparators.
- key notEmpty ifTrue:[ ^ key asSymbol ]
+ key := key withoutSeparators.
+ key notEmpty ifTrue:[ ^ key asSymbol ]
].
^ nil
!
@@ -640,7 +640,7 @@
!
helpTextView
- "the editView which keeps the current help contents assigned to the key
+ "the editView which shows the current help contents assigned to the key
"
^ helpTextView
!
@@ -1352,8 +1352,8 @@
!UIHelpTool::KeyItem methodsFor:'accessing'!
helpKey
- "returns the helpKey, a symbol
- "
+ "returns the helpKey, a symbol"
+
^ helpKey
!