UISpecificationTool.st
changeset 346 38ea269664f8
parent 307 fe559a9136d9
child 350 28128eeb98f0
equal deleted inserted replaced
345:c4d8f4c74c26 346:38ea269664f8
    66   ^ super helpSpec addPairsFrom:#(
    66   ^ super helpSpec addPairsFrom:#(
    67 
    67 
    68 #showRoot
    68 #showRoot
    69 'show or hide the first element into the hierarchical list.'
    69 'show or hide the first element into the hierarchical list.'
    70 
    70 
       
    71 #useIndex
       
    72 'set/clear the useIndex flag. If set, the index of the selection is used otherwise the selected string.'
       
    73 
       
    74 #menuHolder
       
    75 'selector or holder of the middle button menu'
       
    76 
       
    77 #galleryModel
       
    78 'a holder, which keeps the label of the current selected tab or nil.'
       
    79 
       
    80 #listHolder
       
    81 'gets a list or list holder'
       
    82 
       
    83 #document
       
    84 'a holder which keeps the document name to be shown.'
       
    85 
       
    86 #hierarchicalList
       
    87 'gets a hierarchical list or a holder which keeps a hierarchical list entry; the value must be a member of class TreeItem.'
       
    88 
       
    89 #maxChars
       
    90 'set the maximum number of characters that are allowed in the editfield.'
       
    91 
       
    92 #action
       
    93 'action selector sent to the application when the button is activated. (either on-press or on-release; this depends on the setting of triggerOnDown flag). The selector may be for a one-arg message; in this case, the argument is passed (a string).'
       
    94 
       
    95 #canvasSelector
       
    96 'after open the application specified by the clientKey, this selector if not nil will be evaluated,'
       
    97 
       
    98 #enableChannel
       
    99 'enable the view - selection changes are allowed.  This field specifies the name of the aspect (-method or binding) in your application, which is supposed to return a valueHolder holding on to the enable-flag.'
       
   100 
       
   101 #middleButtonPressed
       
   102 'called if the middle button is pressed; you can open a menu'
       
   103 
       
   104 #showDirectoyIndication
       
   105 'show or hide the open/closed indicator on nodes which contains children'
       
   106 
       
   107 #oneTabPerLine
       
   108 'draw only one tab per line'
       
   109 
       
   110 #defaultLabel
       
   111 'set the default label which will be set if nothing selected.'
       
   112 
       
   113 #hierarchicalListButton
       
   114 'opens the hierarchical list editor, which generates and installs a hierarchical list.'
       
   115 
       
   116 #arbitraryView
       
   117 'the widget class shown represented by the arbitrary component or a selector which returns a widget class.'
       
   118 
       
   119 #id
       
   120 'enter the name of the field here. This ID can be used by the application to access components, using #componentAt:<ID>'
       
   121 
       
   122 #sizeAsDefault
       
   123 'let the widget compute its size to include space for the default (return) image. Useful for buttons which are not default buttons initially, but may become a default button dynamically.'
       
   124 
       
   125 #selectionHolder
       
   126 'the one which keeps the selection.'
       
   127 
       
   128 #canvas
       
   129 'gets a widget placed into the notebook'
       
   130 
       
   131 #level
       
   132 'set the level relative to its superView'
       
   133 
       
   134 #majorKey
       
   135 'name of the class which provides the window specification or in case of nil the application itself is used'
       
   136 
       
   137 #isMultiSelect
       
   138 'enable/disable multiple selections.'
       
   139 
       
   140 #gallerySelection
       
   141 'a holder, which keeps the specification of the current selected widget or nil.'
       
   142 
       
   143 #gallerySelectors
       
   144 'the list of selectors specify which interface specification should be used dependent on the tab pressed. Each selector must return an interfaceSpec. On default the #windowSpec method is used'
       
   145 
       
   146 #beDefault
       
   147 'show/dont show a return-key image after the label'
       
   148 
       
   149 #canvasArgument
       
   150 'the argument to the selector or none'
       
   151 
       
   152 #backgroundColor
       
   153 'set the background color'
       
   154 
       
   155 #typeConverter
       
   156 'convert the fields string value to some object'
       
   157 
       
   158 #showLines
       
   159 'show or hide lines'
       
   160 
       
   161 #label
       
   162 'the label of the widget. If ''label is image'' is off, this is the label string. Otherwise, it specifies the applications selector, which returns the label - either a string or a bitmap image.'
       
   163 
       
   164 #minorKey
       
   165 'the selector specifies which interface specification to be used. The selector must return an interfaceSpec. On default the #windowSpec method is used'
       
   166 
       
   167 #showFrame
       
   168 'show the frame'
       
   169 
       
   170 #autoRepeat
       
   171 'repeat the action as long as the button is pressed; to have this behavior the ''isTriggerOnDown'' state must be enabled.'
       
   172 
       
   173 #booleanHolder
       
   174 'a boolean holder which keeps the state'
       
   175 
       
   176 #menuButton
       
   177 'pressing the button will open the menu editor on the specified menu selector.'
       
   178 
       
   179 #galleryLabels
       
   180 'a list of tab labels'
       
   181 
       
   182 #tabLabels
       
   183 'a list or list holder which provides the labels assigned to the tabs.'
       
   184 
       
   185 #fileSelectionTreeRoot
       
   186 'a holder, which keeps the pathname of the root directory (first entry into the list).'
       
   187 
       
   188 #foregroundColor
       
   189 'set the foreground color'
       
   190 
       
   191 #tabWidget
       
   192 'select the tab style'
       
   193 
       
   194 #clientKey
       
   195 'returns an application which provides the builder. On default the application itself is used.'
       
   196 
       
   197 #valueChangeSelector
       
   198 'called whenever the selection changed. If the selector ends with '':'' the method is invoked with the current selection.'
       
   199 
       
   200 #fontMenu
       
   201 'set the font for the widget if the font-checkBox is turned on. Otherwise, the widget uses its default font (which is specified in the viewStyle).'
       
   202 
       
   203 #doubleClickSelector
       
   204 'define the double click action which is evaluated on double click in case of a none nil selection. If the selector ends with '':'' the method is invoked with the current selection.'
       
   205 
    71 #tabOrientation
   206 #tabOrientation
    72 'where to place the tabs'
   207 'where to place the tabs'
    73 
   208 
    74 #menuHolder
       
    75 'selector or holder of the middle button menu'
       
    76 
       
    77 #galleryModel
       
    78 'a holder, which keeps the label of the current selected tab or nil.'
       
    79 
       
    80 #listHolder
       
    81 'gets a list or list holder'
       
    82 
       
    83 #document
       
    84 'a holder which keeps the document name to be shown.'
       
    85 
       
    86 #hierarchicalList
       
    87 'gets a hierarchical list or a holder which keeps a hierarchical list entry; the value must be a member of class TreeItem.'
       
    88 
       
    89 #maxChars
       
    90 'set the maximum number of characters that are allowed in the editfield.'
       
    91 
       
    92 #action
       
    93 'action evaluated when the button is pressed or released which depends on the setting of triggerOnDown flag, either set the press-action and clear any release-action or vice versa, set the release-action and clear the press-action.'
       
    94 
       
    95 #canvasSelector
       
    96 'after open the application specified by the clientKey, this selector if not nil will be evaluated,'
       
    97 
       
    98 #enableChannel
       
    99 'enable the view - selection changes are allowed'
       
   100 
       
   101 #middleButtonPressed
       
   102 'called if the middle button is pressed; you can open a menu'
       
   103 
       
   104 #showDirectoyIndication
       
   105 'show or hide the open/closed indicator on nodes which contains children'
       
   106 
       
   107 #oneTabPerLine
       
   108 'draw only one tab per line'
       
   109 
       
   110 #defaultLabel
       
   111 'set the default label which will be set if nothing selected.'
       
   112 
       
   113 #hierarchicalListButton
       
   114 'opens the hierarchical list editor, which generates and installs a hierarchical list.'
       
   115 
       
   116 #arbitraryView
       
   117 'the widget class shown represented by the arbitrary component or a selector which returns a widget class.'
       
   118 
       
   119 #id
       
   120 'enter the name of the field here. This ID can be used by the application to access components, using #componentAt:<key>'
       
   121 
       
   122 #sizeAsDefault
       
   123 'the size of the widget depends on its label. In case of a fixed Layout nothing will change.'
       
   124 
       
   125 #selectionHolder
       
   126 'the one which keeps the selection.'
       
   127 
       
   128 #canvas
       
   129 'gets a widget placed into the notebook'
       
   130 
       
   131 #level
       
   132 'set the level relative to its superView'
       
   133 
       
   134 #majorKey
       
   135 'name of the class which provides the window specification or in case of nil the application itself is used'
       
   136 
       
   137 #isMultiSelect
       
   138 'enable/disable multiple selections.'
       
   139 
       
   140 #gallerySelection
       
   141 'a holder, which keeps the specification of the current selected widget or nil.'
       
   142 
       
   143 #gallerySelectors
       
   144 'the list of selectors specify which interface specification should be used dependent on the tab pressed. Each selector must return an interfaceSpec. On default the #windowSpec method is used'
       
   145 
       
   146 #beDefault
       
   147 'show/dont show a return-key image after the label'
       
   148 
       
   149 #canvasArgument
       
   150 'the argument to the selector or none'
       
   151 
       
   152 #backgroundColor
       
   153 'set the background color'
       
   154 
       
   155 #typeConverter
       
   156 'convert the fields string value to some object'
       
   157 
       
   158 #showLines
       
   159 'show or hide lines'
       
   160 
       
   161 #label
       
   162 'the label of the widget'
       
   163 
       
   164 #minorKey
       
   165 'the selector specifies which interface specification to be used. The selector must return an interfaceSpec. On default the #windowSpec method is used'
       
   166 
       
   167 #showFrame
       
   168 'show the frame'
       
   169 
       
   170 #autoRepeat
       
   171 'repeat the action as long as the button is pressed; to have this behavior the ''isTriggerOnDown'' state must be enabled'
       
   172 
       
   173 #booleanHolder
       
   174 'a boolean holder which keeps the state'
       
   175 
       
   176 #menuButton
       
   177 'pressing the button will open the menu editor on the specified menu selector.'
       
   178 
       
   179 #galleryLabels
       
   180 'a list of tab labels'
       
   181 
       
   182 #tabLabels
       
   183 'a list or list holder which provides the labels assigned to the tabs.'
       
   184 
       
   185 #fileSelectionTreeRoot
       
   186 'a holder, which keeps the pathname of the root directory (first entry into the list).'
       
   187 
       
   188 #foregroundColor
       
   189 'set the foreground color'
       
   190 
       
   191 #tabWidget
       
   192 'select the tab style'
       
   193 
       
   194 #clientKey
       
   195 'returns an application which provides the builder. On default the application itself is used.'
       
   196 
       
   197 #valueChangeSelector
       
   198 'called whenever the selection changed. If the selector ends with '':'' the method is invoked with the current selection.'
       
   199 
       
   200 #fontMenu
       
   201 'set the font for the widget'
       
   202 
       
   203 #doubleClickSelector
       
   204 'define the double click action which is evaluated on double click in case of a none nil selection. If the selector ends with '':'' the method is invoked with the current selection.'
       
   205 
       
   206 #isTriggerOnDown
   209 #isTriggerOnDown
   207 'if true, the action is evaluated when the button is pressed'
   210 'if true, the action is evaluated when the button is pressed; otherwise, when released.'
   208 
   211 
   209 #borderWidth
   212 #borderWidth
   210 'width of the border'
   213 'width of the border'
   211 
       
   212 #useIndex
       
   213 'set/clear the useIndex flag. If set, the index of the selection is used otherwise the selected string.'
       
   214 
   214 
   215 )
   215 )
   216 ! !
   216 ! !
   217 
   217 
   218 !UISpecificationTool class methodsFor:'interface specs'!
   218 !UISpecificationTool class methodsFor:'interface specs'!