Quelle _Chapter_Francy_Callbacks.xml Sprache: XML

<?xml version="1.0" encoding="UTF-8"?>


<Chapter Label="Chapter_Francy_Callbacks">
<Heading>Francy Callbacks</Heading>

<P/>
<C>Callbacks</C> are objects holding a <C>Function</C>, a list of arguments and a trigger event.
<C>Callbacks</C> are used to execute GAP code from a remote client using the <C>Trigger</C> Operation.
<P/>
<C>Callbacks</C> can be added directly to <C>Menus</C> and <C>Shapes</C>.
<P/>
Please see Francy-JS for client implementation.
<Section Label="Chapter_Francy_Callbacks_Section_Categories">
<Heading>Categories</Heading>

In this section we show all Francy Callback Categories.
<ManSection>
  <Filt Arg="arg" Name="IsCallback" Label="for IsFrancyObject"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Identifies <C>Callback</C> objects.
</Description>
</ManSection>

<ManSection>
  <Filt Arg="arg" Name="IsRequiredArg" Label="for IsFrancyObject"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Identifies <C>RequiredArg</C> objects.
</Description>
</ManSection>

<ManSection>
  <Filt Arg="arg" Name="IsArgType" Label="for IsFrancyTypeObject"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Identifies <C>ArgType</C> objects.
</Description>
</ManSection>

<ManSection>
  <Filt Arg="arg" Name="IsTriggerType" Label="for IsFrancyTypeObject"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Identifies <C>TriggerType</C> objects.
</Description>
</ManSection>

</Section>

<Section Label="Chapter_Francy_Callbacks_Section_Families">
<Heading>Families</Heading>

In this section we show all Francy Callback Families.
</Section>

<Section Label="Chapter_Francy_Callbacks_Section_Representations">
<Heading>Representations</Heading>

In this section we show all Francy Callback Representations.
<ManSection>
  <Filt Arg="arg" Name="IsCallbackRep" Label="for IsComponentObjectRep"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Checks whether an <C>Object</C> has a <C>Callback</C> internal representation.
</Description>
</ManSection>

<ManSection>
  <Filt Arg="arg" Name="IsRequiredArgRep" Label="for IsComponentObjectRep"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Checks whether an <C>Object</C> has a <C>RequiredArg</C> internal representation.
</Description>
</ManSection>

<ManSection>
  <Filt Arg="arg" Name="IsArgTypeRep" Label="for IsComponentObjectRep"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Checks whether an <C>Object</C> has a <C>ArgType</C> internal representation.
</Description>
</ManSection>

<ManSection>
  <Filt Arg="arg" Name="IsTriggerTypeRep" Label="for IsComponentObjectRep"/>
<Returns><K>true</K> or <K>false</K>
</Returns>
<Description>
Checks whether an <C>Object</C> has a <C>TriggerType</C> internal representation.
</Description>
</ManSection>

</Section>

<Section Label="Chapter_Francy_Callbacks_Section_Operations">
<Heading>Operations</Heading>

In this section we show all Francy Callback Operations.
<ManSection>
  <Oper Arg="IsTriggerType, IsFunction, IsList(object)" Name="Callback" Label="for IsTriggerType, IsFunction, IsList"/>
<Returns><C>Callback</C>
</Returns>
<Description>
Creates a <C>Callback</C> object that holds a <C>Function</C> and the <C>RequiredArgs</C> to be executed by a <C>TriggerType</C>.
<P/>
<Emph>Please note, the Function must always <C>Return</C></Emph>
<P/>
Examples:
<P/>
Create a simple <C>Callback</C> with no arguments:
<#Include Label="Example_Create_Callback_1">

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

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

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

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

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

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

<P/>
</Description>
</ManSection>

<ManSection>
  <Oper Arg="" Name="NoopCallback" />
<Returns><C>Callback</C>
</Returns>
<Description>
Creates an empty <C>Callback</C> object that does nothing. Useful to create menu holders.
</Description>
</ManSection>

<ManSection>
  <Oper Arg="IsArgType, IsString(title)" Name="RequiredArg" Label="for IsArgType, IsString"/>
<Returns><C>RequiredArg</C>
</Returns>
<Description>
Creates a <C>Callback</C> with a <C>RequiredArg</C>.
<C>RequiredArg</C> is user input driven and required for the execution of a <C>Callback</C> <C>Function</C>.
The value for this argument will be provided by the user.
</Description>
</ManSection>

<ManSection>
  <Oper Arg="IsString(JSON)" Name="Trigger" Label="for IsString"/>
<Returns>the result of the execution of the <C>Callback</C> defined <C>Function</C>
</Returns>
<Description>
Triggers a <C>Callback</C> <C>Function</C> in GAP.
Gets a JSON String object representation of the callback to execute.
</Description>
</ManSection>

<ManSection>
  <Oper Arg="IsCallback, [IsRequiredArg, List(IsRequiredArg)]" Name="Add" Label="for IsCallback, IsRequiredArg"/>
<Returns><C>Callback</C>
</Returns>
<Description>
Adds a <C>RequiredArg</C> to a specific <C>Callback</C>.
</Description>
</ManSection>

<ManSection>
  <Oper Arg="IsCallback, [IsRequiredArg, List(IsRequiredArg)]" Name="Remove" Label="for IsCallback, IsRequiredArg"/>
<Returns><C>Callback</C>
</Returns>
<Description>
Removes a <C>RequiredArg</C> from a specific <C>Callback</C>.
</Description>
</ManSection>

</Section>

<Section Label="Chapter_Francy_Callbacks_Section_Globals">
<Heading>Globals</Heading>

In this section we show the Global Callback Francy Records for multi purpose.
</Section>

<Section Label="Chapter_Francy_Callbacks_Section_Attributes">
<Heading>Attributes</Heading>

In this section we show the Francy Callback Attributes
<ManSection>
  <Attr Arg="arg" Name="Title" Label="for IsRequiredArg"/>
<Returns><C>IsString</C> with the title of the object
</Returns>
<Description>
A title on a <C>RequiredArg</C> is used to retrieve input from a user.
</Description>
</ManSection>

<ManSection>
  <Oper Arg="arg1" Name="Title" Label="for IsRequiredArg"/>
<Description>
<P/>
</Description>
</ManSection>

<ManSection>
  <Oper Arg="IsRequiredArg, IsString" Name="SetTitle" Label="for IsRequiredArg, IsString"/>
<Description>
Sets the title of the <C>RequiredArg</C>.
</Description>
</ManSection>

<ManSection>
  <Attr Arg="arg" Name="Value" Label="for IsRequiredArg"/>
<Returns><C>IsString</C> with the value of the object
</Returns>
<Description>
A value on a <C>RequiredArg</C> is the actual input value to be passed to back gap from the client GUI.
These values are stored as <C>String</C> for convenience, even if the <C>ArgType</C> specified for the <C>RequiredArg</C> is of another type.
Hence, explicit conversion is required within the <C>Callback</C> <C>Function</C>.
</Description>
</ManSection>

<ManSection>
  <Oper Arg="arg1" Name="Value" Label="for IsRequiredArg"/>
<Description>
<P/>
</Description>
</ManSection>

<ManSection>
  <Oper Arg="IsRequiredArg, IsString" Name="SetValue" Label="for IsRequiredArg, IsString"/>
<Description>
Sets the value of the <C>RequiredArg</C>.
</Description>
</ManSection>

<ManSection>
  <Attr Arg="arg" Name="ConfirmMessage" Label="for IsCallback"/>
<Returns>a <C>IsString</C> with the message to be shown to the user before the <C>Callback</C> execution.
</Returns>
<Description>
This will display a confirmation message before any <C>Callback</C> is executed.
</Description>
</ManSection>

<ManSection>
  <Oper Arg="arg1" Name="ConfirmMessage" Label="for IsCallback"/>
<Description>
<P/>
</Description>
</ManSection>

<ManSection>
  <Oper Arg="IsRequiredArg, IsString" Name="SetConfirmMessage" Label="for IsCallback, IsString"/>
<Description>
Sets the value of the confirmation message to display to the user.
</Description>
</ManSection>

</Section>

</Chapter>

quality100%

¤ Dauer der Verarbeitung: 0.12 Sekunden (vorverarbeitet) ¤

Wurzel

Suchen

Beweissystem der NASA

Beweissystem Isabelle

NIST Cobol Testsuite

Cephes Mathematical Library

Wiener Entwicklungsmethode

Haftungshinweis

Die Informationen auf dieser Webseite wurden nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit, noch Qualität der bereit gestellten Informationen zugesichert.

Bemerkung:

Die farbliche Syntaxdarstellung ist noch experimentell.