Difference between revisions of "toolpalette.enable"
Jump to navigation
Jump to search
m (Text replace - "</u> ||" to "</center></u> ||") |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
toolpalette.'''enable''' is a function that is part of the [[:Category:toolpalette|toolpalette]]. | toolpalette.'''enable''' is a function that is part of the [[:Category:toolpalette|toolpalette]]. | ||
| − | This routine enables or disables a menu item in the tool palette. | + | This routine enables or disables a menu item in the tool palette.<br /> |
| − | This routine returns true if the menu item was properly enabled or disabled. It returns nil if no tool palette has been previously registered by the script app or if the toolname / itemname pair cannot be found in the registered menu items. | + | This routine returns true if the menu item was properly enabled or disabled. |
| − | + | It returns nil if no tool palette has been previously registered by the script app or if the toolname / itemname pair cannot be found in the registered menu items. | |
{{Since|3.0}} | {{Since|3.0}} | ||
| Line 14: | Line 14: | ||
! Parameter !! Type !! Description | ! Parameter !! Type !! Description | ||
|- | |- | ||
| − | | <u>toolname</u> || string || name of the top level toolbox | + | | <u><center>toolname</center></u> || string || name of the top level toolbox |
|- | |- | ||
| − | | <u>itemname</u> || string || name of the menu item | + | | <u><center>itemname</center></u> || string || name of the menu item |
|- | |- | ||
| − | | <u>state</u> || boolean || value that enables the menu item if true or disables the menu item if false. | + | | <u><center>state</center></u> || boolean || value that enables the menu item if true or disables the menu item if false. |
|} | |} | ||
== Example == | == Example == | ||
| − | <syntaxhighlight></syntaxhighlight> | + | <syntaxhighlight>toolpalette.enable("theToolpalette", "firstMenuItem", true)</syntaxhighlight> |
== See also == | == See also == | ||
| − | *[[toolpalette | + | *[[:Category:toolpalette|toolpalette]] |
| − | |||
<br /><br /> | <br /><br /> | ||
[[Category:toolpalette]] | [[Category:toolpalette]] | ||
Latest revision as of 23:42, 30 May 2011
toolpalette.enable is a function that is part of the toolpalette.
This routine enables or disables a menu item in the tool palette.
This routine returns true if the menu item was properly enabled or disabled.
It returns nil if no tool palette has been previously registered by the script app or if the toolname / itemname pair cannot be found in the registered menu items.
This has been introduced in TI-Nspire OS 3.0 (Changes).
Syntax
toolpalette.enable(toolname, itemname, state)
| Parameter | Type | Description |
|---|---|---|
| string | name of the top level toolbox | |
| string | name of the menu item | |
| boolean | value that enables the menu item if true or disables the menu item if false. |
Example
toolpalette.enable("theToolpalette", "firstMenuItem", true)See also
