add some help text
authorca
Wed, 15 Oct 1997 18:03:57 +0200
changeset 338 ea36cf31c084
parent 337 7c36c8b2b495
child 339 121b64d9b39a
add some help text
DataSetBuilder.st
--- a/DataSetBuilder.st	Wed Oct 15 18:03:32 1997 +0200
+++ b/DataSetBuilder.st	Wed Oct 15 18:03:57 1997 +0200
@@ -99,6 +99,7 @@
                  #(#InputFieldSpec
                     #'name:' 'labelField'
                     #'layout:' #(#LayoutFrame 86 0 20 0 -12 1.0 40 0)
+                    #'activeHelpKey:' #label
                     #'model:' #label
                 )
                  #(#FramedBoxSpec
@@ -117,6 +118,7 @@
                            #(#ComboListSpec
                               #'name:' 'rendererField'
                               #'layout:' #(#LayoutFrame 86 0 16 0 17 1.0 36 0)
+                              #'activeHelpKey:' #rendererType
                               #'model:' #rendererType
                               #'comboList:' #rendererTypeList
                               #'useIndex:' false
@@ -130,6 +132,7 @@
                            #(#ComboBoxSpec
                               #'name:' 'editorField'
                               #'layout:' #(#LayoutFrame 86 0 41 0 17 1.0 61 0)
+                              #'activeHelpKey:' #editorField
                               #'model:' #editorType
                               #'type:' #symbolOrNil
                               #'comboList:' #editorTypeList
@@ -157,6 +160,7 @@
                            #(#InputFieldSpec
                               #'name:' 'readSelector'
                               #'layout:' #(#LayoutFrame 86 0 16 0 17 1.0 36 0)
+                              #'activeHelpKey:' #readSelector
                               #'model:' #readSelector
                               #'type:' #symbolOrNil
                           )
@@ -170,6 +174,7 @@
                            #(#InputFieldSpec
                               #'name:' 'menuField'
                               #'layout:' #(#LayoutFrame 86 0 41 0 17 1.0 61 0)
+                              #'activeHelpKey:' #menuSelector
                               #'model:' #menu
                               #'type:' #symbolOrNil
                           )
@@ -183,6 +188,7 @@
                            #(#InputFieldSpec
                               #'name:' 'printSelector'
                               #'layout:' #(#LayoutFrame 86 0 66 0 17 1.0 86 0)
+                              #'activeHelpKey:' #printSelector
                               #'model:' #printSelector
                               #'type:' #symbolOrNil
                           )
@@ -215,11 +221,11 @@
           #'window:' 
            #(#WindowSpec
               #'name:' 'DataSet Details'
-              #'layout:' #(#LayoutFrame 197 0 172 0 487 0 385 0)
+              #'layout:' #(#LayoutFrame 327 0 282 0 617 0 495 0)
               #'label:' 'DataSet Details'
               #'min:' #(#Point 10 10)
               #'max:' #(#Point 1280 1024)
-              #'bounds:' #(#Rectangle 197 172 488 386)
+              #'bounds:' #(#Rectangle 327 282 618 496)
           )
           #'component:' 
            #(#SpecCollection
@@ -240,6 +246,7 @@
                  #(#InputFieldSpec
                     #'name:' 'formatField'
                     #'layout:' #(#LayoutFrame 87 0 37 0 -19 1.0 59 0)
+                    #'activeHelpKey:' #formatString
                     #'model:' #formatString
                 )
                  #(#LabelSpec
@@ -257,6 +264,7 @@
                  #(#ComboListSpec
                     #'name:' 'typeCombo'
                     #'layout:' #(#LayoutFrame 87 0 102 0 289 0 122 0)
+                    #'activeHelpKey:' #type
                     #'model:' #type
                     #'comboList:' #typeList
                     #'useIndex:' false
@@ -270,6 +278,7 @@
                  #(#InputFieldSpec
                     #'name:' 'sizeField'
                     #'layout:' #(#LayoutFrame 87 0 126 0 -19 1.0 148 0)
+                    #'activeHelpKey:' #size
                     #'model:' #size
                     #'type:' #numberOrNil
                 )
@@ -288,6 +297,7 @@
                  #(#InputFieldSpec
                     #'name:' 'choiceField'
                     #'layout:' #(#LayoutFrame 87 0 188 0 -19 1.0 210 0)
+                    #'activeHelpKey:' #choices
                     #'model:' #choices
                     #'type:' #symbolOrNil
                 )
@@ -341,6 +351,7 @@
                            #(#InputFieldSpec
                               #'name:' 'widthField'
                               #'layout:' #(#LayoutFrame 70 0 17 0 0 1.0 39 0)
+                              #'activeHelpKey:' #width
                               #'model:' #width
                               #'type:' #numberOrNil
                           )
@@ -353,6 +364,7 @@
                            #(#InputFieldSpec
                               #'name:' 'minWidthField'
                               #'layout:' #(#LayoutFrame 70 0 46 0 0 1.0 68 0)
+                              #'activeHelpKey:' #minWidth
                               #'model:' #minWidth
                               #'type:' #numberOrNil
                           )
@@ -377,6 +389,7 @@
                            #(#InputFieldSpec
                               #'name:' 'heightField'
                               #'layout:' #(#LayoutFrame 70 0 19 0 0 1.0 41 0)
+                              #'activeHelpKey:' #height
                               #'model:' #height
                               #'type:' #numberOrNil
                           )
@@ -422,6 +435,7 @@
                  #(#CheckBoxSpec
                     #'name:' 'canSelect'
                     #'layout:' #(#Point 17 21)
+                    #'activeHelpKey:' #canSelect
                     #'model:' #canSelect
                     #'label:' 'Is Selectable'
                 )
@@ -434,12 +448,14 @@
                  #(#CheckBoxSpec
                     #'name:' 'showRowSeparator'
                     #'layout:' #(#AlignmentOrigin 86 0 156 0 0 0.5)
+                    #'activeHelpKey:' #showRowSeparator
                     #'model:' #showRowSeparator
                     #'label:' 'Show Row-Separator'
                 )
                  #(#CheckBoxSpec
                     #'name:' 'showColSeparator'
                     #'layout:' #(#AlignmentOrigin 86 0 182 0 0 0.5)
+                    #'activeHelpKey:' #showColumnSeparator
                     #'model:' #showColSeparator
                     #'label:' 'Show Column-Separator'
                 )
@@ -448,6 +464,69 @@
       )
 ! !
 
+!DataSetBuilder class methodsFor:'help specs'!
+
+helpSpec
+    "return a dictionary filled with helpKey -> helptext associations.
+     These are used by the activeHelp tool."
+
+    "
+    UIHelpTool openOnClass:DataSetBuilder    
+    "
+
+  ^ super helpSpec addPairsFrom:#(
+
+#menuSelector
+'a selector to access the middleButton menu or nil'
+
+#canSelect
+'are cells in column selectable'
+
+#formatString
+'string describing special formatting for an input field { #InputField #ComboBox #ComboList }.'
+
+#size
+'max size of an InputField, ComboBox or ComboList. 0 or nil means unlimited.'
+
+#rendererType
+'text description type: how the text should be shown in the cell'
+
+#minWidth
+'makes sense if the width is set to 0 or nil. This is the minimum size required; no computation dependent on the contents. When resizing the view the column may grow or shrink to the minimum width.'
+
+#type
+'a type converter symbol used by the input field'
+
+#label
+'the label of the column'
+
+#choices
+'selector to get the collection of choices for a #ComboBox or #ComboList (optional).'
+
+#showRowSeparator
+'show or hide row separator (bottom horizontal separator)'
+
+#width
+'the width of a fixed column; in case of nil or 0 the column width will be computed dependent on the contents.'
+
+#printSelector
+'a selector with one argument the gc. Used to access a drawable display object (optional). In case of nil, the value derived from the readSelector is shown in the unselected cell.'
+
+#showColumnSeparator
+'show or hide column separator (right vertical separator).'
+
+#height
+'preferred height (optional)'
+
+#editorField
+'type of visual editor (using default editors) or a selector, which will return an visual editor'
+
+#readSelector
+'selector used to get and set a value'
+
+)
+! !
+
 !DataSetBuilder class methodsFor:'images'!
 
 iconCreateItem