config.xml Update Extension

An update extension is invoked when the user invokes the function Parametric -> Update from variables. In order for the an update extension to be invoked, a selected group must have a history that has been set by the same plugin with a call to set_element_history. The id parameter to this function must match the id of the update extension (see below).

Declaration of an update extension in the config.xml:

<extension type="update">
    <id>history-id</id>
    <entry-point>update</entry-point>
</extension>

The following information can be supplied:

• id - (Optional) An identifier string to distinguish several edit extensions. When a user invokes edit in the PYTHA user interface, the update extension is selected by its id-value to match the id supplied in set_element_history.
• entry-point - (Mandatory) Name of the lua function that is invoked when the user presses the button.

The function defined as entry-point will be invoked with one parameter

edit(element)

Parameter	Type	Description
element	element_handle	Element handle of the element that contains the history information

To get the history information for the element, use pytha.get_element_history.

See also:

config.xml, Function Extension, Edit Extension, Attribute Extension, Anatomy of a Lua Api Plugin, Localization and Translation, Element Handles