Difference between revisions of "toolpalette.enable"

From Inspired-Lua Wiki
Jump to navigation Jump to search
Line 3: Line 3:
 
This routine enables or disables a menu item in the tool palette.
 
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 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 22: Line 21:
  
 
== Example  ==
 
== Example  ==
<syntaxhighlight></syntaxhighlight>
+
<syntaxhighlight>toolpalette.enable("theToolpalette", "firstMenuItem", true)</syntaxhighlight>
  
 
== See also  ==
 
== See also  ==
*[[toolpalette]]
+
*[[:Category:toolpalette|toolpalette]]
*[[LINK_2]]
 
  
 
<br /><br />
 
<br /><br />
  
 
[[Category:toolpalette]]
 
[[Category:toolpalette]]

Revision as of 22:56, 24 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
toolname string name of the top level toolbox
itemname string name of the menu item
state boolean value that enables the menu item if true or disables the menu item if false.

Example

toolpalette.enable("theToolpalette", "firstMenuItem", true)

See also