# HG changeset patch
# User tz
# Date 892657765 -7200
# Node ID 96270af95475d2f6a97ad578ccdd4aa7436490db
# Parent 2ffa22f97d5d26cf7f110c7bafe1a8600fb97ecf
help texts revised
diff -r 2ffa22f97d5d -r 96270af95475 UISpecificationTool.st
--- a/UISpecificationTool.st Wed Apr 15 17:17:31 1998 +0200
+++ b/UISpecificationTool.st Wed Apr 15 18:29:25 1998 +0200
@@ -72,28 +72,28 @@
^super helpSpec addPairsFrom:#(
#acceptChannel
-'acceptChannel for the view. 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 accept-flag.\ If the holder changed its value to true, the contents will be accepted and the modifiaction flag is set to false.'
+'Aspect selector or binding for accepting the entry.'
#acceptImmediate
-'input will we sent to the model immediately (every key)'
+'Turns on/off that after each typing in the entry string is sent to the model.'
#acceptOnLeave
-'input will we sent to the model when the field is left via cursor keys'
+'Turns on/off that after leaving the entry field the entry string is sent to the model.'
#acceptOnLostFocus
-'input will we sent to the model when the mouse leaves the field, or its tabbed'
+'Turns on/off that after loosing the focus the entry string is sent to the model.'
#acceptOnReturn
-'input will we sent to the model when the return key is pressed'
+'Turns on/off that after pressing the return key the entry string is sent to the model.'
#acceptOnTab
-'input will we sent to the model when the tab key is pressed'
+'Turns on/off that after pressing the tab key the entry string is sent to the model.'
#action
-'Name of the selector which is sent to the application when the widget is pressed. (If the selector is a one-arg selector, the argument is passed as a string).'
+'Name of the selector which is sent to the application when the widget is pressed.'
#actionArg
-'Argument passed with the action selector. The action selector must end with '':''.'
+'Argument passed with the action selector.'
#appletParamText
'Paste the complete appletTAGs HTML text here (i.e. all from ). Press parse to extract all parameters from it.'
@@ -102,49 +102,49 @@
'Parse the appletTAG and fill the parameters directory from it.'
#arbitraryView
-'the class of the arbitrary component or an aspect selector which provides a widget class.'
+'The class of the arbitrary component or an aspect selector which provides a widget class.'
#archiveEntry
'The name of a zip-file archive, if the class(es) are to be loaded from a zip-archive.'
#arrowButtonDirection
-'Specifies the direction of the arrow.'
+'Defines the direction of the arrow.'
#autoRepeat
-'Turns on/off that the action is evaluated repeatly as long as the button is pressed. To get this behavior, the check box ''Trigger On Down'' must be turned on.'
+'Turns on/off that the action is evaluated repeatly as long as the button is pressed.'
#backgroundChannel
-'Aspect selector or binding for the background color of the widget''s view. It should return a ValueHolder with a Color. (It is useful, if the background color has to be changed dynamically.)'
+'Aspect selector or binding for the background color of the widget.'
#backgroundColor
-'Defines the background color of the widget. After selecting the check toggle the background color can be chosen by selecting the desired colored button. If no color is selected, the widget takes its default background color from the style sheet.'
+'Defines the background color of the widget.'
#beDefault
-'Turns on/off displaying of a return-key after the label.'
+'Turns on/off displaying of a return key after the label string.'
#beDependentOfRows
-'make each row in the list dependant. Thus, whenever a row raises a change notification, the row will be redrawn (if visible on the screen).'
+'Turns on/off that each row in the list is dependent.'
#booleanHolder
-'Aspect of a boolean holder which keeps the state'
+'Aspect selector or binding for en-/disabling the widget.'
#borderWidth
-'width of the border'
+'Defines the width of the border.'
#canvas
-'gets a widget placed into the notebook'
+'Aspect selector or binding for the widget placed into the notebook.'
#canvasArgument
-'the argument to the selector or none'
+'The argument to the selector or none.'
#canvasSelector
-'after opening the application as specified by the clientKey, this message will be sent'
+'The name of the selector sent to the application after opening the canvas.'
#clientHolder
-'holder which provides the sub application to be opened'
+'Aspect selector or binding for holding the client application to be opened.'
#clientKey
-'returns an application which provides the builder. By default the application itself is used.'
+'Returns an application which provides the builder. By default the application itself is used.'
#codeBaseHolder
'The URL of the directory, where the classFile-file resides. If the classFile is located on the local machine, use\ file:/\ where fullPath is an absolute pathname. If its to be accessed via http, use\ http://\ where relativePath is the path relative to the http''s top diretory on that host.'
@@ -153,184 +153,175 @@
'The name of the java classFile which contains the applets code. For example: ''ArcTest.class'''
#columnButton
-'open the dataset builder'
+'Opens a Table Columns Builder.'
#columnHolder
-'valuHolder, which provides a list of column descriptions.'
+'Aspect selector or binding for holding the list of the column descriptions.'
#defaultLabel
-'the default label (used, if nothing selected).'
+'Default label (used, if nothing selected).'
#document
-'a holder which keeps the document name.'
+'Aspect selector or binding for holding the file name of the document.'
#doubleClickSelector
-'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.'
+'Name of the selector sent to the application when double clicked.'
#downAction
-'Name of the selector which is sent to the application when the down(right)-button is pressed. If the selector is an one-arg selector, the argument is passed as a string.'
+'Name of the selector which is sent to the application when the down(right)-button is pressed.'
#enableChannel
-'Aspect selector or binding for en-/disabling of the widget''s view. It should return a boolean ValueHolder.'
+'Aspect selector or binding for en-/disabling of the widget.'
#fileSelectionFilterClas
-'the name of the Item class used to create the entries into the hierarchical list. The class is oblegated to provide the whole interface of the FileSelectionItem class. If no class is specified, the FileSelectionItem class is used. \ Thus you can define your own filter operations, icons, ....'
+'The name of the Item class used to create the entries into the hierarchical list.'
#fileSelectionTreeRoot
-'a holder, which keeps the pathname of the root directory (first entry in the list).'
+'Aspect selector or binding for holding the path name of the root directory.'
#fitLastRow
-'fit rows to tab horizontal or vertical extent'
+'Turns on/off that the tab items are fitted to the width of the widget''s view.'
#fontMenu
-'Defines the font style of the widget. After selecting the check toggle the font style can be chosen by selecting one of the Family/Face/Style/Size buttons. If no font style is selected, the widget takes its default font style from the style sheet.'
+'Defines the font style of the widget.'
#forceRecursiveBackground
-'also change all subcomponents viewBackground (recursively).'
+'Turns on/off that the background color of all sub components is recursively set.'
#foregroundChannel
-'Aspect selector or binding for the foreground color of the widget''s view. It should return a ValueHolder with a Color. (It is useful, if the foreground color has to be changed dynamically.)'
+'Aspect selector or binding for the foreground color of the widget.'
#foregroundColor
-'Defines the foreground color of the widget. After selecting the check toggle the foreground color can be chosen by selecting the desired colored button. If no color is selected, the widget takes its default foreground color from the style sheet.'
+'Defines the foreground color of the widget.'
#galleryLabels
-'a list of tab labels'
+'Aspect selector or binding for holding the list of the labels.'
#galleryModel
-'a holder, which keeps the label of the current selected tab or nil.'
+'Aspect selector or binding for the selected label.'
#gallerySelection
-'a holder, which keeps the specification of the current selected widget or nil.'
+'Aspect selector or binding for the resource specification of the current selected widget.'
#gallerySelectors
-'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'
+'Name of the selector sent to the application returning a list of resource specification selectors.'
#has3Dsepartors
-'show all the column and row separators in a 3D-look'
-
-#hasBorder
-'currently ignored - kept to avoid loosing information of imported VW window specs'
+'Turns on/off that the separators of the columns and rows has a 3D-look.'
#hierarchicalList
-'gets a hierarchical list or a holder which keeps a hierarchical list entry; the value must understand the TreeItem protocol.'
+'Aspect selector or binding for holding the root item of the hierarchical list.'
#hierarchicalListButton
-'opens the hierarchical list editor, which can be used to generate and install a hierarchical list.'
+'Opens a Hierarchical List Editor on the application class and the defined selector.'
#horizontalLayout
-'specifies how components are to be arranged horizontally'
+'Defines how sub components are horizontally arranged.'
#horizontalMiniScroller
-'use a mini-horizontalScroller'
+'Turns on/off that the widget uses a small horizontal scroll bar.'
#horizontalScroller
-'make the view horizontally scrollable'
+'Turns on/off that the widget provides horizontal scrolling capabilities.'
#horizontalSpace
-'horizontal space between elements on pixels'
+'Horizontal space between the sub components (in pixels).'
#id
-'Unique symbolic name (ID) of the widget. This ID can be used by the application to access the view via builder>>componentAt:ID.'
+'Unique symbolic name (ID) of the widget.'
#initiallyDisabled
-'Turns on/off that the view of the widget is initially disabled.'
+'Turns on/off that the widget is initially disabled.'
#initiallyInvisible
-'Turns on/off that the view of the widget is initially invisible.'
+'Turns on/off that the widget is initially invisible.'
#inputFieldGroup
-'symbolic ID of the input group - fields within a group can be reached via cursor up/down.'
+'Unique symbolic name (ID) for the group of the entry field.'
#isMultiSelect
-'enable/disable multiple selections.'
+'Turns on/off whether multiple selections are allowed.'
#isOpaque
-'define how the widget is displayed; opaque or not opaque'
+'Turns on/off that widget is displayed opaque.'
#isTriggerOnDown
'Turns on/off that the action is evaluated when the button is pressed; otherwise, when released.'
#label
-'The label of the button. If the check box ''Label Is Image'' is turned off, this is the label string. Otherwise, it is the name of the selector, which returns the label - either a string or a bitmap image from the application.'
+'The label of the button.'
#labelChannel
-'Aspect selector or binding for the label of the widget''s view. It should return a ValueHolder with a String. (It is useful, if the label has to be changed dynamically.)'
+'Aspect selector or binding for the label of the widget.'
#labelIsImage
-'Turns on/off that the name of the label is taken as selector. The selector should return a string or bitmap image used as logo in the widget.'
+'Turns on/off that the string of the label is taken as selector.'
#labelPositionList
-'define the position of the label'
+'Defines the position of the label.'
#lampColor
-'Defines the lamp color of the widget. After selecting the check toggle the lamp color can be chosen by selecting the desired colored button. If no color is selected, the widget takes its default lamp color from the style sheet.'
+'Defines the lamp color of the widget.'
#level
-'the 3D-level relative to its superView. If left blank, the components default is used.'
+'Defines the width of the 3D-border.'
#listHolder
-'a list or a list holders aspect'
+'Aspect selector or binding for holding the list.'
#majorKey
-'name of the class which provides the window specification. If left blank, the application itself is used.'
+'Name of the class which provides the window specification. If left blank, the application itself is used.'
#maxChars
-'maximum number of characters that are allowed in the editfield. If left blank, no limit is set.'
+'Maximum number of characters which can be typed in.'
#maxSize
'Those two fields specify the windows maximum size. The user will not be allowed to resize it to a larger size.'
#maxXField
-'the maximum width - the user will not be allowed to resize the topView to a larger width.'
+'The maximum allowed width of the application window.'
#maxYField
-'the maximum height - the user will not be allowed to resize the topView to a larger height.'
+'The maximum allowed height of the application window.'
#menuButton
-'Opens a Menu Editor on the application class and the defined selector.'
-
-#menuHolder
-'aspect selector or holder which provides the middle button menu'
+'Opens a Menu Editor on the application class and the defined selector.'
#menuId
-'Aspect selector or binding for the building of the tool bar components. It should return a menu spec.'
+'Aspect selector or binding for the building of the tool bar components. It should return a menu spec.'
#menuPerformer
-'Aspect selector or binding for sending the messages of the tool bar items to an object. It should return an object which can receive the messages.'
+'Aspect selector or binding for sending the messages of the menu items to an object.'
#middleButtonPressed
-'called if the middle button is pressed; you can open a menu'
-
-#minSize
-'Those two fields specify the windows minimum size. The user will not be allowed to resize it to a smaller size.'
+'Name of the selector sent to the application when the middle button is pressed.'
#minXField
-'the minimum width - the user will not be allowed to resize the topView to a smaller width.'
+'The minimum allowed width of the application window.'
#minYField
-'the minimum height - the user will not be allowed to resize the topView to a smaller height.'
+'The minimum allowed height of the application window.'
#minorKey
-'the selector specifies which interface specification to be used. The selector must return an interfaceSpec. By default the #windowSpec method is used.'
+'Name of the selector sent to the application returning a window specification.'
#modifiedChannel
-'modifiedHolder for the view. 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 modified-flag. \ The holder is set dependant on the modification state of the view contents.'
+'Aspect selector or binding for setting the widget as modified.'
#monitoring
-'start or stop a background process, which will update the list dependant on any directory change.\ Between each check cycle, there is a defined delay time measured in seconds.'
+'Turns on/off that the widget automatically updates, if the contents of the current directory has changed.'
#monitoringDelayTime
-'delay time of the monitoring task in seconds'
+'Number of the seconds for the delays of the monitoring tasks.'
#moveSelectedRow
-'move selected row always to view'
+'Turns on/off that the row of the selected tab item is always moved down to the widget''s view.'
#oneTabPerLine
-'draw only one tab per line'
+'Turns on/off that only one tab item is drawn per line.'
#openSubSpecGuiHelp
-'Start a GUI Builder for this subspecification.'
+'Opens a GUI Builder on the defined class and selector.'
#orientation
'Defines the direction of the alignment of the two arrows (horizontal or vertical).'
@@ -354,127 +345,121 @@
''
#radioButtonGroup
-'the aspect of the valueHolder which holds the selection of a radioButtonGroup. When clicked, each button writes its value into that aspect; vice versa, if the groupValue is changed to the value of one of the buttons, that button turns itself on.'
+'Aspect selector or binding for the group definitions of the radio buttons.'
#radioButtonValue
-'the value associated with that radioButton. When clicked, this will be stored into the group-model. If left empty, buttons are numbered sequentially, starting with 1.'
+'Defines the string which is set in the RadioButtonGroup instance above when pressed.'
#readOnly
-'the field is readOnly - its contents cannot be modified by the user (however, the program can)'
+'Turns on/off that the contents of the widget cannot be modified.'
#regionType
-'define the shape of the widget'
+'Defines the shape of the widget.'
#resizeForLabel
-'if on, the widget is allowed to resize itself to fit the labelString - if off, the size is frozen.'
+'Turns on/off whether the widget recomputes its layout, if the extent of the string has changed.'
#rowIfAbsent
-'name of a method in the application which is invoked whenever an empty list entry is detected. The method is called with the index into the list and should return a valid row instance. \ Thus, you are able to define a list with all elements set to nil.'
+'Name of the selector sent to the application when an empty list entry is detected.'
#selectConditionSelector
-'name of a method in the application which is invoked before the selection changed. The selection will not be done, if the method returns false. \ If the selector ends with '':'' the method is invoked with the selection-line-number as argument.'
+'Name of the selector sent to the application before a selection is performed.'
#selectionHolder
-'the aspect of the valueHolder which holds the selection or input value.'
+'Aspect selector or binding for holding the selected value.'
#setMaxExtent
-'set the maximum size from the topViews current size.'
+'Picks the current extent of the canvas window and sets it as the maximum extent.'
#setMinExtent
-'set the minumum size from the topViews current size.'
+'Picks the current extent of the canvas window and sets it as the minimum extent.'
#showDirectoryIndicator
-'enable/disable directory indicator (+/-) for none empty directories'
+'Turns on/off that directory indicators are shown for none empty directories.'
#showDirectoryIndicatorForRoot
-'disable the directory indicator for the first element of the hierarchical list in case that the global directory indication is set to true.'
-
-#showFrame
-'show the frame'
+'Turns on/off that a directory indicator for the root item is shown.'
#showLamp
'Turns on/off that a colored lamp is shown.'
#showLines
-'show or hide lines'
+'Turns on/off that connecting lines are shown between the tree items.'
#showPercentage
-'define if the percentage is to be shown numerically'
+'Turns on/off that a number of percentage is shown.'
#showRoot
-'show or hide the first element of the hierarchical list.'
+'Turns on/off that the root item is shown.'
#showSeparatingLines
-'seperate each menu item by a vertical or horizontal line dependant on its vertical layout'
+'Turns on/off that the items are separated by lines.'
#sizeAsDefault
-'Turns on/off that the widget computes its size including space for the default (return) image. Useful for buttons which are initially not default buttons , but may become a default button dynamically.'
+'Turns on/off that the widget computes its size including space for the default (return) image.'
#specHolder
-'holder which provides the selector to access the windowspec used to open the sub application derived from the application holder. If no selector is defined, the #windowSpec selector is used.'
+'Aspect selector or binding for holding the selector returning a window specification.'
#start
-'define the scroller/slider''s range minimum'
+'Defines the minimum number of the range.'
#step
-'define the scroller/slider''s range step'
+'Defines the step number of the range.'
#stop
-'define the scroller/slider''s range maximum'
+'Defines the maximum number of the range.'
#tabLabels
-'a list or list holder which provides the labels assigned to the tabs.'
+'Name of the selector sent to the application returning a list of labels for the tab items.'
#tabOrientation
-'where to place the tabs'
+'Defines the side for the arrangement of the tab items.'
#tabWidget
-'select the tab style (windows- or mac look)'
+'Defines the type of the border style of the tab items (Windows or Mac).'
#tabable
-'Turns on/off that the view of the widget can be reached by tabbing.'
+'Turns on/off that the widget can be reached by pressing the tab key.'
#translateLabel
-'Turns on/off that the label string is translated via the resource mechanism to a national language string. A translation for that string must be defined in the resource file of the application class.'
+'Turns on/off that the label string is translated via the resource mechanism to a national language string.'
#typeConverter
-'convert the fields string value to some other object. Needed if the aspectValue is not a string (typically numbers).'
+'Defines how the entry field is converted to an object which is sent to the model.'
#upAction
-'Name of the selector which is sent to the application when the up(left)-button is pressed. If the selector is an one-arg selector, the argument is passed as a string.'
+'Name of the selector which is sent to the application when the up(left)-button is pressed.'
#useIndex
-'set/clear the useIndex flag. If set, the index of the selection is stored into the model; otherwise the selected string.'
+'Turns on/off that the value model of the selection is provided by the current list index of the item.'
#usePreferredExtent
-'Take the top components preferredExtent as extent of the topView. Only possible if there is exactly one top component (typically: a panel).'
+'Turns on/off that the window application takes its preferredExtent from the top component.'
#validateDoubleClickSelector
-'name of a method in the application which is invoked before a not empty directory is opened by a double click. If the method returns false, the directory will not be opened.\ If the selector ends with '':'' the method is invoked with the selection-line-number as argument.'
+'Name of the selector sent to the application before a not empty directory is opened by a double click.'
#valueChangeSelector
-'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.'
+'Name of the selector sent to the application when the widget/item has selected.'
#verticalLayout
-'specifies how components are to be arranged vertically'
+'Defines how sub components are vertically arranged.'
#verticalMiniScroller
-'use a mini-verticalScroller'
+'Turns on/off that the widget uses a small vertical scroll bar.'
#verticalScroller
-'make the view vertically scrollable'
+'Turns on/off that the widget provides vertical scrolling capabilities.'
#verticalSpace
-'the vertical space between elements on pixels'
+'Vertical space between the sub components (in pixels).'
#windowIcon
-'aspect of the windows icon. This is supposed to provide a bitmap image, which is displayed by the windowManager if your applications gets iconified.'
-
-#windowIconLabel
-'the windows icon label. This will be displayed by most windowManagers in the icon if the topView is iconified.'
+'Name of the selector sent to the application returning a bitmap image for the icon representation of the window application.'
#windowLabel
-'the windows label. This will be displayed by the windowManager in the windows frame.'
+'Label of the window application.'
)
! !