UISpecificationTool.st
changeset 350 28128eeb98f0
parent 346 38ea269664f8
child 364 c175e197f050
equal deleted inserted replaced
349:1f5c236558fc 350:28128eeb98f0
    63     UIHelpTool openOnClass:UISpecificationTool    
    63     UIHelpTool openOnClass:UISpecificationTool    
    64     "
    64     "
    65 
    65 
    66   ^ super helpSpec addPairsFrom:#(
    66   ^ super helpSpec addPairsFrom:#(
    67 
    67 
    68 #showRoot
    68 #action
    69 'show or hide the first element into the hierarchical list.'
    69 '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).'
    70 
    70 
    71 #useIndex
    71 #arbitraryView
    72 'set/clear the useIndex flag. If set, the index of the selection is used otherwise the selected string.'
    72 'the class of the arbitrary component or an aspect selector which provides a widget class.'
    73 
    73 
    74 #menuHolder
    74 #autoRepeat
    75 'selector or holder of the middle button menu'
    75 'repeat the action as long as the button is pressed; to have this behavior the ''isTriggerOnDown'' state must be enabled.'
       
    76 
       
    77 #backgroundColor
       
    78 'set the background color if the color-checkBox is turned on. Otherwise, the widget uses its default background color (which is specified in the styleSheet).'
       
    79 
       
    80 #beDefault
       
    81 'show/dont show a return-key image after the label'
       
    82 
       
    83 #booleanHolder
       
    84 'a boolean holder which keeps the state'
       
    85 
       
    86 #borderWidth
       
    87 'width of the border'
       
    88 
       
    89 #canvas
       
    90 'gets a widget placed into the notebook'
       
    91 
       
    92 #canvasArgument
       
    93 'the argument to the selector or none'
       
    94 
       
    95 #canvasSelector
       
    96 'after opening the application as specified by the clientKey,  this message will be sent'
       
    97 
       
    98 #clientKey
       
    99 'returns an application which provides the builder. By default the application itself is used.'
       
   100 
       
   101 #defaultLabel
       
   102 'the default label  (used, if nothing selected).'
       
   103 
       
   104 #document
       
   105 'a holder which keeps the document name.'
       
   106 
       
   107 #doubleClickSelector
       
   108 'double click action which is evaluated on double click in  case of a non-nil selection.  If the selector ends with '':'' the method is invoked with the current selection as argument.'
       
   109 
       
   110 #enableChannel
       
   111 '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 on to the boolean enable-flag.'
       
   112 
       
   113 #fileSelectionTreeRoot
       
   114 'a holder, which keeps the pathname of the root directory (first entry in the list).'
       
   115 
       
   116 #fontMenu
       
   117 '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).'
       
   118 
       
   119 #foregroundColor
       
   120 'set the foreground color if the color-checkBox is turned on. Otherwise, the widget uses its default foreground color (which is specified in the styleSheet).'
       
   121 
       
   122 #galleryLabels
       
   123 'a list of tab labels'
    76 
   124 
    77 #galleryModel
   125 #galleryModel
    78 'a holder, which keeps the label of the current selected tab or nil.'
   126 'a holder, which keeps the label of the current selected tab or nil.'
    79 
   127 
       
   128 #gallerySelection
       
   129 'a holder, which keeps the specification of the current selected widget or nil.'
       
   130 
       
   131 #gallerySelectors
       
   132 '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'
       
   133 
       
   134 #hierarchicalList
       
   135 'gets a hierarchical list or a holder which keeps a hierarchical list entry; the value must understand the TreeItem protocol.'
       
   136 
       
   137 #hierarchicalListButton
       
   138 'opens the hierarchical list editor, which can be used to generate and install a hierarchical list.'
       
   139 
       
   140 #horizontalLayout
       
   141 'specifies how components are to be arranged horizontally'
       
   142 
       
   143 #horizontalMiniScroller
       
   144 'use a mini-horizontalScroller'
       
   145 
       
   146 #horizontalScroller
       
   147 'make the view horizontally scrollable'
       
   148 
       
   149 #id
       
   150 'the symbolic name of the component.  This ID can be used by the application to access components, using #componentAt:<ID>'
       
   151 
       
   152 #isMultiSelect
       
   153 'enable/disable multiple selections.'
       
   154 
       
   155 #isTriggerOnDown
       
   156 'if true, the action is evaluated when the button is pressed; otherwise, when released.'
       
   157 
       
   158 #label
       
   159 '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.'
       
   160 
       
   161 #level
       
   162 'the 3D-level relative to its superView. If left blank, the components default is used.'
       
   163 
    80 #listHolder
   164 #listHolder
    81 'gets a list or list holder'
   165 'a list or a list holders aspect'
    82 
   166 
    83 #document
   167 #majorKey
    84 'a holder which keeps the document name to be shown.'
   168 'name of the class which provides the window specification. If left blank, the application itself is used.'
    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 
   169 
    89 #maxChars
   170 #maxChars
    90 'set the maximum number of characters that are allowed in the editfield.'
   171 'maximum number of characters that are allowed in the editfield.  If left blank, no limit is set.'
    91 
   172 
    92 #action
   173 #maxSize
    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).'
   174 'Those two fields specify the windows maximum size. The user will not be allowed to resize it to a larger size.'
    94 
   175 
    95 #canvasSelector
   176 #maxXField
    96 'after open the application specified by the clientKey, this selector if not nil will be evaluated,'
   177 'the maximum width - the user will not be allowed to resize the topView to a larger width.'
    97 
   178 
    98 #enableChannel
   179 #maxYField
    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.'
   180 'the maximum height - the user will not be allowed to resize the topView to a larger height.'
       
   181 
       
   182 #menuButton
       
   183 'open a menu editor on the specified menu selector.'
       
   184 
       
   185 #menuHolder
       
   186 'aspect selector or holder which provides the middle button menu'
       
   187 
       
   188 #menuId
       
   189 'the aspect of the menu. The application may respond to this message by returning a menu.'
       
   190 
       
   191 #menuPerformer
       
   192 'aspect providing an object which gets the menu messages. If left blank, the menu sends its menuMessages to the application.'
   100 
   193 
   101 #middleButtonPressed
   194 #middleButtonPressed
   102 'called if the middle button is pressed; you can open a menu'
   195 'called if the middle button is pressed; you can open a menu'
   103 
   196 
   104 #showDirectoyIndication
   197 #minSize
   105 'show or hide the open/closed indicator on nodes which contains children'
   198 'Those two fields specify the windows minimum size. The user will not be allowed to resize it to a smaller size.'
       
   199 
       
   200 #minXField
       
   201 'the minimum width - the user will not be allowed to resize the topView to a smaller width.'
       
   202 
       
   203 #minYField
       
   204 'the minimum height - the user will not be allowed to resize the topView to a smaller height.'
       
   205 
       
   206 #minorKey
       
   207 'the selector specifies which interface specification to be used. The selector must return an interfaceSpec. By default the #windowSpec method is used.'
   106 
   208 
   107 #oneTabPerLine
   209 #oneTabPerLine
   108 'draw only one tab per line'
   210 'draw only one tab per line'
   109 
   211 
   110 #defaultLabel
   212 #selectionHolder
   111 'set the default label which will be set if nothing selected.'
   213 'the one which keeps the selection.'
   112 
   214 
   113 #hierarchicalListButton
   215 #setMaxExtent
   114 'opens the hierarchical list editor, which generates and installs a hierarchical list.'
   216 'set the maximum size from the topViews current size.'
   115 
   217 
   116 #arbitraryView
   218 #setMinExtent
   117 'the widget class shown represented by the arbitrary component or a selector which returns a widget class.'
   219 'set the minumum size from the topViews current size.'
   118 
   220 
   119 #id
   221 #showDirectoryIndication
   120 'enter the name of the field here. This ID can be used by the application to access components, using #componentAt:<ID>'
   222 'show or hide the open/closed indicator on nodes which contains children'
       
   223 
       
   224 #showFrame
       
   225 'show the frame'
       
   226 
       
   227 #showLines
       
   228 'show or hide lines'
       
   229 
       
   230 #showRoot
       
   231 'show or hide the first element of the hierarchical list.'
   121 
   232 
   122 #sizeAsDefault
   233 #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.'
   234 '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 
   235 
   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
   236 #tabLabels
   183 'a list or list holder which provides the labels assigned to the tabs.'
   237 'a list or list holder which provides the labels assigned to the tabs.'
   184 
   238 
   185 #fileSelectionTreeRoot
   239 #tabOrientation
   186 'a holder, which keeps the pathname of the root directory (first entry into the list).'
   240 'where to place the tabs'
   187 
       
   188 #foregroundColor
       
   189 'set the foreground color'
       
   190 
   241 
   191 #tabWidget
   242 #tabWidget
   192 'select the tab style'
   243 'select the tab style'
   193 
   244 
   194 #clientKey
   245 #typeConverter
   195 'returns an application which provides the builder. On default the application itself is used.'
   246 'convert the fields string value to some other object. Needed if the aspectValue is not a string (typically numbers).'
       
   247 
       
   248 #useIndex
       
   249 'set/clear the useIndex flag. If set, the index of the selection is stored into the model; otherwise the selected string.'
   196 
   250 
   197 #valueChangeSelector
   251 #valueChangeSelector
   198 'called whenever the selection changed. If the selector ends with '':'' the method is invoked with the current selection.'
   252 'name of a method in the application which is invoked whenever the selection changed. If the selector ends with '':'' the method is invoked with the current selection.'
   199 
   253 
   200 #fontMenu
   254 #verticalLayout
   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).'
   255 'specifies how components are to be arranged vertically'
   202 
   256 
   203 #doubleClickSelector
   257 #verticalMiniScroller
   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.'
   258 'use a mini-verticalScroller'
   205 
   259 
   206 #tabOrientation
   260 #verticalScroller
   207 'where to place the tabs'
   261 'make the view vertically scrollable'
   208 
   262 
   209 #isTriggerOnDown
   263 #windowIcon
   210 'if true, the action is evaluated when the button is pressed; otherwise, when released.'
   264 'aspect of the windows icon. This is supposed to provide a bitmap image, which is displayed by the windowManager if your applications gets iconified.'
   211 
   265 
   212 #borderWidth
   266 #windowIconLabel
   213 'width of the border'
   267 'the windows icon label. This will be displayed by most windowManagers in the icon if the topView is iconified.'
       
   268 
       
   269 #windowLabel
       
   270 'the windows label. This will be displayed by the windowManager in the windows frame.'
   214 
   271 
   215 )
   272 )
       
   273 
       
   274     "Modified: / 27.10.1997 / 22:30:27 / cg"
   216 ! !
   275 ! !
   217 
   276 
   218 !UISpecificationTool class methodsFor:'interface specs'!
   277 !UISpecificationTool class methodsFor:'interface specs'!
   219 
   278 
   220 windowSpec
   279 windowSpec