Changeset 2157

Timestamp:

Mar 27, 2011 3:13:21 PM (12 years ago)

Author:

mmc

Message:

Added support for -tooltip options on all attributes, and added descriptions
of attributes to all objects. This gives the user pop-up help inside the
builder.

Location:

trunk/lang/tcl/scripts

Files:

• objects.tcl (modified) (1 diff)
• objects/base.rp (modified) (1 diff)
• objects/boolean/boolean.rp (modified) (1 diff)
• objects/choice/choice.rp (modified) (1 diff)
• objects/curve/curve.rp (modified) (1 diff)
• objects/histogram/histogram.rp (modified) (1 diff)
• objects/image/image.rp (modified) (1 diff)
• objects/integer/integer.rp (modified) (1 diff)
• objects/note/note.rp (modified) (1 diff)
• objects/number/number.rp (modified) (1 diff)
• objects/string/string.rp (modified) (1 diff)
• types/boolean.tcl (modified) (2 diffs)
• types/choices.tcl (modified) (5 diffs)
• types/color.tcl (modified) (2 diffs)
• types/file.tcl (modified) (1 diff)
• types/image.tcl (modified) (2 diffs)
• types/language.tcl (modified) (4 diffs)
• types/string.tcl (modified) (2 diffs)
• types/units.tcl (modified) (3 diffs)

trunk/lang/tcl/scripts/objects.tcl

@@ -865 +865 @@
     public variable only ""
     public variable expand "no"
+    public variable tooltip ""
 
     constructor {args} {

trunk/lang/tcl/scripts/objects/base.rp

@@ -1 +1 @@
 object base {
-    attr label -title "Label" -type string -path about.label
-    attr description -title "Description" -type string:lines=3 -expand yes -path about.description
-    attr enable -title "Enable" -type string:validate=enable -path about.enable -only input
+    attr label -title "Label" -type string -path about.label -tooltip "Short label for the object, indicating what it represents."
+
+    attr description -title "Description" -type string:lines=3 -expand yes -path about.description -tooltip "Brief description of the object, which appears in a tooltip when the user mouses over the value.  Avoid repeating the label.  Instead, add information about what the object represents for your simulator, what it affects as an input, or what it means as an output."
+
+    attr enable -title "Enable" -type string:validate=enable -path about.enable -only input -tooltip "Use this to enable/disable an input.  A value of \"false\" permanently disables the input.  More commonly, the value is an expression that indicates when the input should be enabled.\nEXAMPLE: input.choice(model) == \"dd\""
+
 
     check label {

trunk/lang/tcl/scripts/objects/boolean/boolean.rp

@@ -18 +18 @@
     help http://rappture.org/wiki/rp_xml_ele_boolean
 
-    attr default -title "Default Value" -type boolean -path default -only input
+    attr default -title "Default Value" -type boolean -path default -only input -tooltip "Sets the value that this input has when the program first starts.  This value is used by default unless the user explicitly changes it."
 
     check default {

trunk/lang/tcl/scripts/objects/choice/choice.rp

@@ -18 +18 @@
     help http://rappture.org/wiki/rp_xml_ele_choice
 
-    attr options -title "Options" -type choices -path option
-    attr default -title "Default Value" -type string -path default -only input
+    attr options -title "Options" -type choices -path option -tooltip "List of choices that will appear on the drop-down menu in your program."
+
+    attr default -title "Default Value" -type string -path default -only input -tooltip "Sets the value that this input has when the program first starts.  This value is used by default unless the user explicitly changes it."
 
     check options {

trunk/lang/tcl/scripts/objects/curve/curve.rp

@@ -19 +19 @@
     help http://rappture.org/wiki/rp_xml_ele_curve
 
-    attr group -title "Plotting Group" -type string -path about.group
-    attr xlabel -title "X-axis Label" -type string -path xaxis.label
-    attr xdesc  -title "X-axis Description" -type string -path xaxis.description
-    attr xunits -title "X-axis Units" -type units -path xaxis.units
-    attr ylabel -title "Y-axis Label" -type string -path yaxis.label
-    attr ydesc  -title "Y-axis Description" -type string -path yaxis.description
-    attr yunits -title "Y-axis Units" -type units -path yaxis.units
+    attr group -title "Plotting Group" -type string -path about.group -tooltip "If two or more curves share the same name for their plotting group, they are overlayed on the same plot.  The name for the plotting group becomes the name of the overall output, and the label for each curve appears in a tooltip when you mouse over its points."
+
+    attr xlabel -title "X-axis Label" -type string -path xaxis.label -tooltip "Label shown on the x-axis for the plot."
+
+    attr xdesc  -title "X-axis Description" -type string -path xaxis.description -tooltip "Description of the x-axis that appears in a tooltip window when you mouse over the x-axis.  This should not merely repeat what the label says, but explain what it means."
+
+    attr xunits -title "X-axis Units" -type units -path xaxis.units -tooltip "Units for the physical quantity that the x-axis represents."
+
+    attr ylabel -title "Y-axis Label" -type string -path yaxis.label -tooltip "Label shown on the y-axis for the plot."
+
+    attr ydesc  -title "Y-axis Description" -type string -path yaxis.description -tooltip "Description of the y-axis that appears in a tooltip window when you mouse over the y-axis.  This should not merely repeat what the label says, but explain what it means."
+
+    attr yunits -title "Y-axis Units" -type units -path yaxis.units -tooltip "Units for the physical quantity that the y-axis represents."
+
 
     check xlabel {

trunk/lang/tcl/scripts/objects/histogram/histogram.rp

@@ -19 +19 @@
     help http://rappture.org/wiki/rp_xml_ele_histogram
 
-    attr xlabel -title "X-axis Label" -type string -path xaxis.label
-    attr xdesc  -title "X-axis Description" -type string -path xaxis.description
-    attr xunits -title "X-axis Units" -type units -path xaxis.units
-    attr ylabel -title "Y-axis Label" -type string -path yaxis.label
-    attr ydesc  -title "Y-axis Description" -type string -path yaxis.description
-    attr yunits -title "Y-axis Units" -type units -path yaxis.units
+    attr xlabel -title "X-axis Label" -type string -path xaxis.label -tooltip "Label shown on the x-axis for the plot."
+
+    attr xdesc  -title "X-axis Description" -type string -path xaxis.description -tooltip "Description of the x-axis that appears in a tooltip window when you mouse over the x-axis.  This should not merely repeat what the label says, but explain what it means."
+
+    attr xunits -title "X-axis Units" -type units -path xaxis.units -tooltip "Units for the physical quantity that the x-axis represents."
+
+    attr ylabel -title "Y-axis Label" -type string -path yaxis.label -tooltip "Label shown on the y-axis for the plot."
+
+    attr ydesc  -title "Y-axis Description" -type string -path yaxis.description -tooltip "Description of the y-axis that appears in a tooltip window when you mouse over the y-axis.  This should not merely repeat what the label says, but explain what it means."
+
+    attr yunits -title "Y-axis Units" -type units -path yaxis.units -tooltip "Units for the physical quantity that the y-axis represents."
+
 
     check xlabel {

trunk/lang/tcl/scripts/objects/image/image.rp

@@ -18 +18 @@
     help http://rappture.org/wiki/rp_xml_ele_image
 
-    attr default -title "Default Value" -type image -path default
-    attr resize -title "Resize" -type string:validate=imresize -path resize
-    attr convert -title "Convert" -type string:validate=imformat -path convert
+    attr default -title "Default Value" -type image -path default -tooltip "Sets the value that this input has when the program first starts.  This value is used by default unless the user explicitly changes it."
+
+    attr resize -title "Resize" -type string:validate=imresize -path resize -only input -tooltip "Limits the size of the thumbnail shown for any image uploaded into this input.  Valid options are:  auto, none, width=XX, height=XX"
+
+    attr convert -title "Convert" -type string:validate=imformat -path convert -only input -tooltip "Causes the image to be converted to a particular image format before being passed along to your simulation program.  Valid options are:  bmp, gif, ico, jpeg, pcx, png, pgm, ppm, ps, pdf, sgi, sun, tga, tiff, xbm, xpm"
+
 
     storage {

trunk/lang/tcl/scripts/objects/integer/integer.rp

@@ -18 +18 @@
     help http://rappture.org/wiki/rp_xml_ele_integer
 
-    attr default -title "Default Value" -type string:validate=int -path default -only input
-    attr min -title "Minimum Value" -type string:validate=int -path min -only input
-    attr max -title "Maximum Value" -type string:validate=int -path max -only input
+    attr default -title "Default Value" -type string:validate=int -path default -only input -tooltip "Sets the value that this input has when the program first starts.  This value is used by default unless the user explicitly changes it."
+
+    attr min -title "Minimum Value" -type string:validate=int -path min -only input -tooltip "Sets the minimum value for this integer.  The value can be equal to the minimum, but no lower."
+
+    attr max -title "Maximum Value" -type string:validate=int -path max -only input -tooltip "Sets the maximum value for this integer.  The value can be equal to the maximum, but no higher."
+
 
     check default {

trunk/lang/tcl/scripts/objects/note/note.rp

@@ -19 +19 @@
     help http://rappture.org/wiki/rp_xml_ele_note
 
-    attr contents -title "HTML File" -type file -path contents
+    attr contents -title "HTML File" -type file -path contents -tooltip "Name of an HTML file loaded into the note area as documentation.  The file may contain embedded images and links, as long as those files reside in the same directory as the HTML file or have explicit http:// paths."
+
 
     check contents {

trunk/lang/tcl/scripts/objects/number/number.rp

@@ -18 +18 @@
     help http://rappture.org/wiki/rp_xml_ele_number
 
-    attr default -title "Default Value" -type string:validate=number -path default -only input
-    attr units -title "Units of Measurement" -type units -path units
-    attr min -title "Minimum Value" -type string:validate=number -path min -only input
-    attr max -title "Maximum Value" -type string:validate=number -path max -only input
-    attr icon -title "Icon" -type image:maxsize=20,rescale=yes -path about.icon -only input
-    attr color -title "Color" -type color -path color -only input
+    attr default -title "Default Value" -type string:validate=number -path default -only input -tooltip "Sets the value that this input has when the program first starts.  This value is used by default unless the user explicitly changes it."
+
+    attr units -title "Units of Measurement" -type units -path units -tooltip "Units for the physical quantity that this number represents."
+
+    attr min -title "Minimum Value" -type string:validate=number -path min -only input -tooltip "Sets the minimum value for this number.  The value can be equal to the minimum, but no lower."
+
+    attr max -title "Maximum Value" -type string:validate=number -path max -only input -tooltip "Sets the maximum value for this number.  The value can be equal to the maximum, but no higher."
+
+    attr icon -title "Icon" -type image:maxsize=20,rescale=yes -path about.icon -only input -tooltip "Sets an icon shown next to the number, which is normally used to indicate the quantity that the number represents.  If the icon is transparent, any color set for the number will show through."
+
+    attr color -title "Color" -type color -path color -only input -tooltip "Sets the color shown next to the number to indicate its strength.  If the number is near the minimum, the color will be white; as it nears the maximum, it will be the color selected here."
+
 
     check default {

trunk/lang/tcl/scripts/objects/string/string.rp

@@ -18 +18 @@
     help http://rappture.org/wiki/rp_xml_ele_string
 
-    attr default -title "Default Value" -type string -path default -only input
-    attr size -title "Size" -type string:validate=size -path size -only input
-    attr hints -title "Hint String" -type string -path about.hints -only input
+    attr default -title "Default Value" -type string -path default -only input -tooltip "Sets the value that this input has when the program first starts.  This value is used by default unless the user explicitly changes it."
+
+    attr size -title "Size" -type string:validate=size -path size -only input -tooltip "Sets the desired size for the string.  Strings are normally 1 line of text, but if the size is set to some WxH, then the entry area will be at least W chars wide and H lines tall.  For example, 40x5 says that the string should be 40 chars wide and 10 lines tall."
+
+    attr hints -title "Hint String" -type string -path about.hints -only input -tooltip "Sets a line of text displayed beneath the entry area for the string.  This is used to give a hint to the user about what should be entered in the string area."
+
 
     storage {

trunk/lang/tcl/scripts/types/boolean.tcl

@@ -14 +14 @@
     constructor {win args} {
         Rappture::getopts args params {
+            value -tooltip ""
         }
 
@@ -19 +20 @@
         pack $win.val -side left
         $win.val choices insert end 1 "True" 0 "False"
+
+        Rappture::Tooltip::for $win.val $params(-tooltip)
+
         set _win $win
     }

trunk/lang/tcl/scripts/types/choices.tcl

@@ -14 +14 @@
     constructor {win args} {
         Rappture::getopts args params {
+            value -tooltip ""
         }
 
@@ -20 +21 @@
         button $win.cntls.add -text "Add" -command [itcl::code $this _add]
         pack $win.cntls.add -side left
+        Rappture::Tooltip::for $win.cntls.add "Adds a new option to the list of choices."
         button $win.cntls.del -text "Delete" -command [itcl::code $this _delete]
         pack $win.cntls.del -side right
+        Rappture::Tooltip::for $win.cntls.del "Removes an option from the list of choices."
 
         Rappture::Scroller $win.scrl -height 1.5i \
@@ -29 +32 @@
         bind $win.scrl.lbox <<ListboxSelect>> [itcl::code $this _edit]
         $win.scrl contents $win.scrl.lbox
+        Rappture::Tooltip::for $win.scrl.lbox $params(-tooltip)
 
         frame $win.editelem
@@ -39 +43 @@
         grid $win.editelem.l -row 1 -column 0 -sticky e
         entry $win.editelem.label
+        Rappture::Tooltip::for $win.editelem.label "Label for the option that appears in the drop-down list of choices."
         grid $win.editelem.label -row 1 -column 1 -columnspan 2 -sticky ew
         label $win.editelem.v -text "Value:"
         grid $win.editelem.v -row 2 -column 0 -sticky e
         entry $win.editelem.value
+        Rappture::Tooltip::for $win.editelem.value "Value for the option reported to your program when this choice is selected."
         grid $win.editelem.value -row 2 -column 1 -sticky ew
         label $win.editelem.vopt -text "(optional)"
@@ -52 +58 @@
         text $win.editelem.scrl.desc -wrap char
         $win.editelem.scrl contents $win.editelem.scrl.desc
+        Rappture::Tooltip::for $win.editelem.scrl.desc "Description of the option that appears in the tooltip when you mouse over the choice when it appears in the combobox."
 
         bind $win.editelem.label <KeyPress-Return> \

trunk/lang/tcl/scripts/types/color.tcl

@@ -13 +13 @@
     constructor {win args} {
         Rappture::getopts args params {
+            value -tooltip ""
         }
         set _icon [image create photo -width 20 -height 20]
@@ -18 +19 @@
         label $win.sample -image $_icon
         pack $win.sample -side left
+        Rappture::Tooltip::for $win.sample $params(-tooltip)
+
         button $win.change -text "Choose..." -command [itcl::code $this choose]
         pack $win.change -side left

trunk/lang/tcl/scripts/types/file.tcl

@@ -16 +16 @@
     constructor {win args} {
         Rappture::getopts args params {
+            value -tooltip ""
         }
         label $win.file -text "select a file" -width 10 -anchor e -fg gray60
         pack $win.file -side left
+        Rappture::Tooltip::for $win.file $params(-tooltip)
+
         button $win.getfile -text "Choose..." -command [itcl::code $this _getfile]
         pack $win.getfile -side left

trunk/lang/tcl/scripts/types/image.tcl

@@ -15 +15 @@
             value -maxsize ""
             value -rescale no
+            value -tooltip ""
         }
         set _currview [image create photo]
@@ -22 +23 @@
         label $win.image -image $_currview -borderwidth 1 -relief solid
         pack $win.image -side left
+        Rappture::Tooltip::for $win.image $params(-tooltip)
 
         frame $win.btns

trunk/lang/tcl/scripts/types/language.tcl

@@ -17 +17 @@
     constructor {win args} {
         Rappture::getopts args params {
+            value -tooltip ""
         }
 
@@ -28 +29 @@
         bind $win.val <<Value>> [itcl::code $this _react]
 
+        Rappture::Tooltip::for $win.val $params(-tooltip)
+
         frame $win.custom
         label $win.custom.l -text "Command:"
@@ -33 +36 @@
         entry $win.custom.val
         pack $win.custom.val -side left -expand yes -fill x
+        Rappture::Tooltip::for $win.custom.val "Enter the command line that Rappture should invoke to run your simulation program.  Include @driver somewhere on this line; it will be replaced with the name of the Rappture driver file (usually passed in as the first argument on the command line).  If you include @tool, it will be replaced with the name of the directory where the tool.xml file is installed.  Instead of hard-coding your program path, you can express it as a relative path from @tool."
 
         set _win $win
@@ -95 +99 @@
 
     public proc export {xmlobj path value} {
-        $xmlobj put $path $value
+        set value [string trim $value]
+        if {$value ne ""} {
+            $xmlobj put $path $value
+        }
     }
 

trunk/lang/tcl/scripts/types/string.tcl

@@ -20 +20 @@
             value -lines 1
             value -validate ""
+            value -tooltip ""
         }
 
@@ -27 +28 @@
             text $win.scrl.text -width 10 -height $params(-lines) -wrap word
             $win.scrl contents $win.scrl.text
+            Rappture::Tooltip::for $win.scrl.text $params(-tooltip)
         } else {
             entry $win.str
             pack $win.str -fill x
+            Rappture::Tooltip::for $win.str $params(-tooltip)
         }
         set _win $win

trunk/lang/tcl/scripts/types/units.tcl

@@ -14 +14 @@
     constructor {win args} {
         Rappture::getopts args params {
+            value -tooltip ""
         }
 
@@ -57 +58 @@
           T   "  T - Teslas" \
           G   "  G - Gauss"
+
+        Rappture::Tooltip::for $win.val $params(-tooltip)
 
         set _win $win
@@ -113 +116 @@
 
     public proc export {xmlobj path value} {
-        $xmlobj put $path $value
+        set value [string trim $value]
+        if {$value ne ""} {
+            $xmlobj put $path $value
+        }
     }