Francy Callbacks

Callbacks are objects holding a Function, a list of arguments and a trigger event. Callbacks are used to execute GAP code from a remote client using the Trigger Operation.

Callbacks can be added directly to Menus and Shapes.

Please see Francy-JS for client implementation.
Categories In this section we show all Francy Callback Categories. true or false Identifies Callback objects. true or false Identifies RequiredArg objects. true or false Identifies ArgType objects. true or false Identifies TriggerType objects.
Families In this section we show all Francy Callback Families.
Representations In this section we show all Francy Callback Representations. true or false Checks whether an Object has a Callback internal representation. true or false Checks whether an Object has a RequiredArg internal representation. true or false Checks whether an Object has a ArgType internal representation. true or false Checks whether an Object has a TriggerType internal representation.
Operations In this section we show all Francy Callback Operations. Callback Creates a Callback object that holds a Function and the RequiredArgs to be executed by a TriggerType.

Please note, the Function must always Return

Examples:

Create a simple Callback with no arguments: <#Include Label="Example_Create_Callback_1">

Create a Callback with one required argument of type string: <#Include Label="Example_Create_Callback_2">

Create a Callback with one known argument of type string: <#Include Label="Example_Create_Callback_3">

Create a Callback with one known argument and one required argument of type string: <#Include Label="Example_Create_Callback_4">

Create a Callback with one known argument and one required argument of type string and double click trigger Type: <#Include Label="Example_Create_Callback_5">

In order to see the output of the previous examples, we have to simulate the external call to Trigger operation: <#Include Label="Example_Create_Callback_6">

Create a Noop Callback, useful for Menu holders, where no Function is required: <#Include Label="Example_Create_Callback_7">

Callback Creates an empty Callback object that does nothing. Useful to create menu holders. RequiredArg Creates a Callback with a RequiredArg. RequiredArg is user input driven and required for the execution of a Callback Function. The value for this argument will be provided by the user. the result of the execution of the Callback defined Function Triggers a Callback Function in GAP. Gets a JSON String object representation of the callback to execute. Callback Adds a RequiredArg to a specific Callback. Callback Removes a RequiredArg from a specific Callback.
Globals In this section we show the Global Callback Francy Records for multi purpose.
Attributes In this section we show the Francy Callback Attributes IsString with the title of the object A title on a RequiredArg is used to retrieve input from a user.

Sets the title of the RequiredArg. IsString with the value of the object A value on a RequiredArg is the actual input value to be passed to back gap from the client GUI. These values are stored as String for convenience, even if the ArgType specified for the RequiredArg is of another type. Hence, explicit conversion is required within the Callback Function.

Sets the value of the RequiredArg. a IsString with the message to be shown to the user before the Callback execution. This will display a confirmation message before any Callback is executed.

Sets the value of the confirmation message to display to the user.