Difference between revisions of "toolpalette.register"

From Inspired-Lua Wiki
Jump to navigation Jump to search
(Created page with "toolpalette'''register''' is a function that is part of the toolpalette. toolpalette.'''register''' may be called once in the top level flow of the s...")
 
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
toolpalette'''register''' is a function that is part of the [[:Category:toolpalette| toolpalette]].
+
toolpalette.'''register''' is a function that is part of the [[:Category:toolpalette| toolpalette]].
  
−
 
+
toolpalette.'''register''' may be called once in the top level flow of the script app. Once registered, the tool palette is managed automatically by the Nspire framework.<br />
−
toolpalette.'''register''' may be called once in the top level flow of the script app. Once registered, the tool palette is managed automatically by the Nspire framework.
 
 
When the user chooses an item from a toolbox, the associated function is called with two parameters: the name of the toolbox and the name of the menu item.
 
When the user chooses an item from a toolbox, the associated function is called with two parameters: the name of the toolbox and the name of the menu item.
−
 
  
 
{{Since|3.0}}
 
{{Since|3.0}}
  
 
== Syntax  ==
 
== Syntax  ==
−
'''functionName'''(arg1, arg2, arg3 [,arg4])  
+
toolPalette.'''register'''(menuStructure)  
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 15: Line 13:
 
! Parameter !! Type !! Description
 
! Parameter !! Type !! Description
 
|-
 
|-
−
| <u>menuStructure</u> || (multi-level)-table || Description of arg1
+
| <u><center>menuStructure</center></u> || (multi-level)-table || Table describing the name of each tool box, the menus that appear in each tool box, and the function to call when the user invokes the menu item
−
|-
+
   
 
|}
 
|}
  
 
== Example  ==
 
== Example  ==
−
<syntaxhighlight>menu = {
+
 
−
 
+
The script app uses this routine to register its tool palette with the Nspire framework.
−
     {“Mode”,                          -- Tool box “Mode”
+
 
−
       {“Decimal”, setDec},          -- Menu item “Decimal” calls function setDec()
+
<syntaxhighlight>
−
       {“Hexadecimal”, setHex},
+
 
−
       {“Octal”, setOct},
+
function setDec()
−
       {“Binary”, setBin},
+
  ...
−
       “-“,                          -- Section divider
+
end
−
       {“Signed”, setSigned},
+
 
−
       {“Unsigned”, setUnsigned},
+
-- All your functions defined in the menu --
−
    },
+
 
−
    {“Boolean”,
+
menu = {
−
      {“And”, binopAnd},
+
−
      {“Or”, binopOr},
+
     {"Analysis",                          -- Tool box "Mode"
−
      {“XOr”, binopXor},
+
       {"Decimal", setDec},          -- Menu item "Decimal" calls function setDec()
−
      {“Not”, unopNot},
+
       {"Hexadecimal", setHex},
 +
       {"Octal", setOct},
 +
       {"Binary", setBin},
 +
       "-",                          -- Section divider
 +
       {"Signed", setSigned},
 +
       {"Unsigned", setUnsigned},
 
     },
 
     },
 +
    {"Boolean",
 +
      {"And", binopAnd},
 +
      {"Or", binopOr},
 +
      {"XOr", binopXor},
 +
      {"Not", unopNot},
 +
    }
 +
 
}
 
}
 +
 
toolpalette.register(menu)</syntaxhighlight>
 
toolpalette.register(menu)</syntaxhighlight>
  
 
== See also  ==
 
== See also  ==
−
*[[LINK_1]]
+
*[[:Category:toolpalette|toolpalette]]
−
*[[LINK_2]]
+
*[[toolpalette.enable]]
  
 
<br /><br />
 
<br /><br />
  
−
[[Category:toolPalette]]
+
[[Category:toolpalette]]
−
 
 
−
 
 
−
 
 
−
The script app uses this routine to register its tool palette with the Nspire framework. The menu structure is a table describing the name of each tool box, the menus that appear in each tool box, and the function to call when the user invokes the menu item.
 
−
This example demonstrates the layout of a toolpalette’s menu structure.
 

Latest revision as of 11:20, 21 December 2011

toolpalette.register is a function that is part of the toolpalette.

toolpalette.register may be called once in the top level flow of the script app. Once registered, the tool palette is managed automatically by the Nspire framework.
When the user chooses an item from a toolbox, the associated function is called with two parameters: the name of the toolbox and the name of the menu item.

This has been introduced in TI-Nspire OS 3.0 (Changes).


Syntax

toolPalette.register(menuStructure)

Parameter Type Description
menuStructure
 (multi-level)-table Table describing the name of each tool box, the menus that appear in each tool box, and the function to call when the user invokes the menu item

Example

The script app uses this routine to register its tool palette with the Nspire framework. 

function setDec()
   ...
end

-- All your functions defined in the menu --

menu = {
 
    {"Analysis",                          -- Tool box "Mode"
       {"Decimal", setDec},           -- Menu item "Decimal" calls function setDec()
       {"Hexadecimal", setHex},
       {"Octal", setOct},
       {"Binary", setBin},
       "-",                           -- Section divider
       {"Signed", setSigned},
       {"Unsigned", setUnsigned},
    },
    {"Boolean",
       {"And", binopAnd},
       {"Or", binopOr},
       {"XOr", binopXor},
       {"Not", unopNot},
    }
 
}
 
toolpalette.register(menu)

See also



Retrieved from "https://wiki.inspired-lua.org/index.php?title=toolpalette.register&oldid=611"