ToolDatabase: Difference between revisions
No edit summary |
|||
Line 8: | Line 8: | ||
===ToolDatabase=== | ===ToolDatabase=== | ||
Returns a new object which gives access to the single Tool database for the program. e.g | Returns a new object which gives access to the single Tool database for the program. | ||
::''e.g | |||
::''local tooldb = ToolDatabase()'' | |||
: | ===:GetTool(ToolDBId tooldb_id) === | ||
Return the tool from the database with the given Id. | |||
===ToolDBId === | |||
This is an object used to locate a selected tool with its location in the tool database. It is retrieved by the tool through Tool.ToolDBId and is useful for saving and loading defaults. | |||
--Constructor -- | |||
ToolDBId(string section, string key_prefix) – constructor Create an Id object from the contents of the registry | |||
Section – string – section name in the registry | |||
Key_prefix – string – prefix for the registry keys (could be empty) in case multiple tools are used in the same gadget | |||
==Methods== | ==Methods== |
Revision as of 09:08, 4 August 2021
The ToolDatabase object gives access to the single Tool database within the program. Currently this object can only be used to select an existing tool from the database.
Constructor
ToolDatabase
Returns a new object which gives access to the single Tool database for the program.
- e.g
- local tooldb = ToolDatabase()
:GetTool(ToolDBId tooldb_id)
Return the tool from the database with the given Id.
ToolDBId
This is an object used to locate a selected tool with its location in the tool database. It is retrieved by the tool through Tool.ToolDBId and is useful for saving and loading defaults.
--Constructor -- ToolDBId(string section, string key_prefix) – constructor Create an Id object from the contents of the registry Section – string – section name in the registry Key_prefix – string – prefix for the registry keys (could be empty) in case multiple tools are used in the same gadget
Methods
:SelectTool()
Displays the Tool Database dialog and allows the user to choose a tool which is returned from this method.
For Example:
local tool_database = ToolDatabase() local tool = tool_database:SelectTool()
:GetTool(ToolDBId tooldb_id)
Return the tool from the database with the given Id.
References
Please Note: The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 10.0, published August 21, 2019. by Vectric Ltd. Most current document from Vertric can be downloaded at Vertric Developer Information