products/Sources/formale Sprachen/GAP/pkg/francy/doc/chap2_mj.html
<?xml version="1.0" encoding="UTF-8" ?>DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd " >html xmlns="http://www.w3.org/1999/xhtml " xml:lang="en" >head >script type="text/javascript" "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML " >script >title >GAP (Francy) - Chapter 2: Francy Callbacks</title >meta http-equiv="content-type" content="text/html; charset=UTF-8" />meta name="generator" content="GAPDoc2HTML" />link rel="stylesheet" type="text/css" href="manual.css" />script src="manual.js" type="text/javascript" ></script >script type="text/javascript" >overwriteStyle();</script >head >body class="chap2" onload="jscontent()" >div class="chlinktop" ><span class="chlink1" >Goto Chapter: </span ><a href="chap0_mj.html" >Top</a> <a href="chap1_mj.html" >1</a> <a href="chap2_mj.html" >2</a> <a href="chap3_mj.html" >3</a> <a href="chap4_mj.html" >4</a> <a href="chap5_mj.html" >5</a> <a href="chap6_mj.html" >6</a> <a href="chap7_mj.html" >7</a> <a href="chap8_mj.html" >8</a> <a href="chap9_mj.html" >9</a> <a href="chap10_mj.html" >10</a> <a href="chapInd_mj.html" >Ind</a> </div >div class="chlinkprevnexttop" > <a href="chap0_mj.html" >[Top of Book]</a> <a href="chap0_mj.html#contents" >[Contents]</a> <a href="chap1_mj.html" >[Previous Chapter]</a> <a href="chap3_mj.html" >[Next Chapter]</a> </div >"mathjaxlink" class="pcenter" ><a href="chap2.html" >[MathJax off]</a></p>"X7FD77853879BC3F6" name="X7FD77853879BC3F6" ></a></p>div class="ChapSects" ><a href="chap2_mj.html#X7FD77853879BC3F6" >2 <span class="Heading" >Francy Callbacks</span ></a>div class="ContSect" ><span class="tocline" ><span class="nocss" > </span ><a href="chap2_mj.html#X7CC6903E78F24167" >2.1 <span class="Heading" >Categories</span ></a>span >div class="ContSSBlock" >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7961360C802B12AF" >2.1-1 IsCallback</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7B5CD72681DECF6C" >2.1-2 IsRequiredArg</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7B7E0C807948B7AF" >2.1-3 IsArgType</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X8563CE3284411B39" >2.1-4 IsTriggerType</a></span >div ></div >div class="ContSect" ><span class="tocline" ><span class="nocss" > </span ><a href="chap2_mj.html#X846063757EC05986" >2.2 <span class="Heading" >Families</span ></a>span >div >div class="ContSect" ><span class="tocline" ><span class="nocss" > </span ><a href="chap2_mj.html#X7EABCC537D3BC549" >2.3 <span class="Heading" >Representations</span ></a>span >div class="ContSSBlock" >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X810BE3BC849642C6" >2.3-1 IsCallbackRep</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X81CE336A8401CCFA" >2.3-2 IsRequiredArgRep</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X8154ABB67C695006" >2.3-3 IsArgTypeRep</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7D26E6EB7C6CD408" >2.3-4 IsTriggerTypeRep</a></span >div ></div >div class="ContSect" ><span class="tocline" ><span class="nocss" > </span ><a href="chap2_mj.html#X7DE8E16C7C2D387B" >2.4 <span class="Heading" >Operations</span ></a>span >div class="ContSSBlock" >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X8039D4AA7A14B983" >2.4-1 Callback</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X79FB842583B96033" >2.4-2 NoopCallback</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X842979BE7C0694A1" >2.4-3 RequiredArg</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7AF6D2BC85C96A6D" >2.4-4 Trigger</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X83FF6BEE7DBC8617" >2.4-5 Add</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7F67A0CE8601BE21" >2.4-6 Remove</a></span >div ></div >div class="ContSect" ><span class="tocline" ><span class="nocss" > </span ><a href="chap2_mj.html#X859DA3398653FCC5" >2.5 <span class="Heading" >Globals</span ></a>span >div >div class="ContSect" ><span class="tocline" ><span class="nocss" > </span ><a href="chap2_mj.html#X7C701DBF7BAE649A" >2.6 <span class="Heading" >Attributes</span ></a>span >div class="ContSSBlock" >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7A58A55E806E5F68" >2.6-1 Title </a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7A58A55E806E5F68" >2.6-2 Title </a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7888408386F15D29" >2.6-3 SetTitle</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X78733FD481F16F77" >2.6-4 Value</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X78733FD481F16F77" >2.6-5 Value</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7C4F7F027E8AF083" >2.6-6 SetValue</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X87AA56767C7BB01F" >2.6-7 ConfirmMessage</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X87AA56767C7BB01F" >2.6-8 ConfirmMessage</a></span >span class="ContSS" ><br /><span class="nocss" > </span ><a href="chap2_mj.html#X7F4046A17BBE64F1" >2.6-9 SetConfirmMessage</a></span >div ></div >div >span class="Heading" >Francy Callbacks</span ></h3>code class="code" >Callbacks</code > are objects holding a <code class="code" >Function</code >, a list of arguments and a trigger event. <code class="code" >Callbacks</code > are used to execute GAP code code class="code" >Trigger</code > Operation.</p>code class="code" >Callbacks</code > can be added directly to <code class="code" >Menus</code > and <code "code" >Shapes</code >.</p>"X7CC6903E78F24167" name="X7CC6903E78F24167" ></a></p>span class="Heading" >Categories</span ></h4>section we show all Francy Callback Categories.</p>"X7961360C802B12AF" name="X7961360C802B12AF" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ IsCallback</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( filter )</td ></tr ></table ></div >code class="keyw" >true</code > or <code class="keyw" >false</code ></p>code class="code" >Callback</code > objects.</p>"X7B5CD72681DECF6C" name="X7B5CD72681DECF6C" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ IsRequiredArg</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( filter )</td ></tr ></table ></div >code class="keyw" >true</code > or <code class="keyw" >false</code ></p>code class="code" >RequiredArg</code > objects.</p>"X7B7E0C807948B7AF" name="X7B7E0C807948B7AF" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ IsArgType</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( filter )</td ></tr ></table ></div >code class="keyw" >true</code > or <code class="keyw" >false</code ></p>code class="code" >ArgType</code > objects.</p>"X8563CE3284411B39" name="X8563CE3284411B39" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ IsTriggerType</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( filter )</td ></tr ></table ></div >code class="keyw" >true</code > or <code class="keyw" >false</code ></p>code class="code" >TriggerType</code > objects.</p>"X846063757EC05986" name="X846063757EC05986" ></a></p>span class="Heading" >Families</span ></h4>section we show all Francy Callback Families.</p>"X7EABCC537D3BC549" name="X7EABCC537D3BC549" ></a></p>span class="Heading" >Representations</span ></h4>section we show all Francy Callback Representations.</p>"X810BE3BC849642C6" name="X810BE3BC849642C6" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ IsCallbackRep</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( filter )</td ></tr ></table ></div >code class="keyw" >true</code > or <code class="keyw" >false</code ></p>code class="code" >Object </code > has a <code class="code" >Callback</code > internal representation.</p>"X81CE336A8401CCFA" name="X81CE336A8401CCFA" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ IsRequiredArgRep</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( filter )</td ></tr ></table ></div >code class="keyw" >true</code > or <code class="keyw" >false</code ></p>code class="code" >Object </code > has a <code class="code" >RequiredArg</code > internal representation.</p>"X8154ABB67C695006" name="X8154ABB67C695006" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ IsArgTypeRep</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( filter )</td ></tr ></table ></div >code class="keyw" >true</code > or <code class="keyw" >false</code ></p>code class="code" >Object </code > has a <code class="code" >ArgType</code > internal representation.</p>"X7D26E6EB7C6CD408" name="X7D26E6EB7C6CD408" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ IsTriggerTypeRep</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( filter )</td ></tr ></table ></div >code class="keyw" >true</code > or <code class="keyw" >false</code ></p>code class="code" >Object </code > has a <code class="code" >TriggerType</code > internal representation.</p>"X7DE8E16C7C2D387B" name="X7DE8E16C7C2D387B" ></a></p>span class="Heading" >Operations</span ></h4>section we show all Francy Callback Operations.</p>"X8039D4AA7A14B983" name="X8039D4AA7A14B983" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ Callback</code >( <var class="Arg" >IsTriggerType</var >, <var class="Arg" >IsFunction</var >, <var class="Arg" >IsList(object )</var > )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >code class="code" >Callback</code ></p>code class="code" >Callback</code > object that holds a <code class="code" >Function</code > and the <code class="code" >RequiredArgs</code > to be executed by a <code class="code" >TriggerType</code >.</p>em >Please note, the Function must always <code class="code" >Return</code ></em ></p>code class="code" >Callback</code > with no arguments:</p>div class="example" ><pre >span class="GAPprompt" >gap></span > <span class="GAPinput" >MyFunction := function() return "Hello World!" ; end;</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >callback := Callback(MyFunction);</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >Id(callback);</span >pre ></div >code class="code" >Callback</code > with one required argument of type string:</p>div class="example" ><pre >span class="GAPprompt" >gap></span > <span class="GAPinput" >MyFunction := function(str) return Concatenation("Hello" , " " , str); end;</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >callback := Callback(MyFunction);</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >arg := RequiredArg(ArgType.STRING, "Your Name" );</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >Add(callback, arg);</span >pre ></div >code class="code" >Callback</code > with one known argument of type string:</p>div class="example" ><pre >span class="GAPprompt" >gap></span > <span class="GAPinput" >MyFunction := function(args) return args; end;</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >callback := Callback(MyFunction, ["Hello World" span >pre ></div >code class="code" >Callback</code > with one known argument and one required argument of type string:</p>div class="example" ><pre >span class="GAPprompt" >gap></span > <span class="GAPinput" >MyFunction := function(a,b) return Concatenation(a, b); end;</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >callback := Callback(MyFunction, ["Hello " span >span class="GAPprompt" >gap></span > <span class="GAPinput" >arg := RequiredArg(ArgType.STRING, "Your Name" );</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >Add(callback, arg);</span >pre ></div >code class="code" >Callback</code > with one known argument and one required argument of type string and double click trigger Type:</p>div class="example" ><pre >span class="GAPprompt" >gap></span > <span class="GAPinput" >MyFunction := function(a,b) return Concatenation(a, b); end;</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >callback := Callback(TriggerType.DOUBLE_CLICK, MyFunction, ["Hello " ]);</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >arg := RequiredArg(ArgType.STRING, "Your Name" );</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >Add(callback, arg);</span >pre ></div >output of the previous examples, we have to simulate the external call to <code class="code" >Trigger</code > operation:</p>div class="example" ><pre >span class="GAPprompt" >gap></span > <span class="GAPinput" >MyFunction := function(a,b) return Concatenation(a, b); end;</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >callback := Callback(TriggerType.DOUBLE_CLICK, MyFunction, ["Hello " ]);</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >arg := RequiredArg(ArgType.STRING, "Your Name" );</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >SetTitle(arg, "Enter your name" );</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >Title (arg);</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >Add(callback, arg);</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >SetValue(arg, "Manuel" ); # simulate the user input </span >span class="GAPprompt" >gap></span > <span class="GAPinput" >Value(arg);</span >span class="GAPprompt" >gap></span > <span class="GAPinput" >Trigger(GapToJsonString(Sanitize(callback))); # simulate the external trigger</span >pre ></div >Menu holders, where no <code class="code" >Function</code > is required:</p>div class="example" ><pre >span class="GAPprompt" >gap></span > <span class="GAPinput" >callback := NoopCallback();</span >pre ></div >"X79FB842583B96033" name="X79FB842583B96033" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ NoopCallback</code >( )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >code class="code" >Callback</code ></p>code class="code" >Callback</code > object that does nothing. Useful to create menu "X842979BE7C0694A1" name="X842979BE7C0694A1" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ RequiredArg</code >( <var class="Arg" >IsArgType</var >, <var class="Arg" >IsString(title )</var > )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >code class="code" >RequiredArg</code ></p>code class="code" >Callback</code > with a <code class="code" >RequiredArg</code >. <code class="code" >RequiredArg</code > is user input driven and required for the execution of a <code class="code" >Callback</code > <code class="code" >Function</code >. The value for this argument will be provided by the user.</p>"X7AF6D2BC85C96A6D" name="X7AF6D2BC85C96A6D" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ Trigger</code >( <var class="Arg" >IsString(JSON)</var > )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >code class="code" >Callback</code > defined <code class="code" >Function</code ></p>code class="code" >Callback</code > <code class="code" >Function</code > in GAP. Gets a JSON String object representation of the callback to execute.</p>"X83FF6BEE7DBC8617" name="X83FF6BEE7DBC8617" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ Add</code >( <var class="Arg" >IsCallback</var >[, <var class="Arg" >IsRequiredArg</var >, <var class="Arg" >List(IsRequiredArg)</var >] )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >code class="code" >Callback</code ></p>code class="code" >RequiredArg</code > to a specific <code class="code" >Callback</code >.</p>"X7F67A0CE8601BE21" name="X7F67A0CE8601BE21" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ Remove</code >( <var class="Arg" >IsCallback</var >[, <var class="Arg" >IsRequiredArg</var >, <var class="Arg" var >] )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >code class="code" >Callback</code ></p>code class="code" >RequiredArg</code > from a specific <code class="code" >Callback</code >.</p>"X859DA3398653FCC5" name="X859DA3398653FCC5" ></a></p>span class="Heading" >Globals</span ></h4>section we show the Global Callback Francy Records for multi purpose.</p>"X7C701DBF7BAE649A" name="X7C701DBF7BAE649A" ></a></p>span class="Heading" >Attributes</span ></h4>section we show the Francy Callback Attributes</p>"X7A58A55E806E5F68" name="X7A58A55E806E5F68" ></a></p>Title </h5>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ Title </code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( attribute )</td ></tr ></table ></div >code class="code" >IsString</code > with the title of the object </p>title on a <code class="code" >RequiredArg</code > is used to retrieve input from a user.</p>"X7A58A55E806E5F68" name="X7A58A55E806E5F68" ></a></p>Title </h5>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ Title </code >( <var class="Arg" >arg1</var > )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >"X7888408386F15D29" name="X7888408386F15D29" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ SetTitle</code >( <var class="Arg" >IsRequiredArg</var >, <var class="Arg" >IsString</var > )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >title of the <code class="code" >RequiredArg</code >.</p>"X78733FD481F16F77" name="X78733FD481F16F77" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ Value</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( attribute )</td ></tr ></table ></div >code class="code" >IsString</code > with the value of the object </p>code class="code" >RequiredArg</code > is the actual input value to be passed to back gap from the client GUI. These values are stored as <code class="code" >String</code > for convenience, even if the <code class="code" >ArgType</code > specified for the <code class="code" >RequiredArg</code > is of another type. Hence, explicit conversion is required within the <code class="code" >Callback</code > <code class="code" >Function</code >.</p>"X78733FD481F16F77" name="X78733FD481F16F77" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ Value</code >( <var class="Arg" >arg1</var > )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >"X7C4F7F027E8AF083" name="X7C4F7F027E8AF083" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ SetValue</code >( <var class="Arg" >IsRequiredArg</var >, <var class="Arg" >IsString</var > )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >code class="code" >RequiredArg</code >.</p>"X87AA56767C7BB01F" name="X87AA56767C7BB01F" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ ConfirmMessage</code >( <var class="Arg" >arg</var > )</td ><td class="tdright" >( attribute )</td ></tr ></table ></div >code class="code" >IsString</code > with the message to be shown to the user before the <code "code" >Callback</code > execution.</p>code class="code" >Callback</code > is executed.</p>"X87AA56767C7BB01F" name="X87AA56767C7BB01F" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ ConfirmMessage</code >( <var class="Arg" >arg1</var > )</td ><td class="tdright" >( operation )</td ></tr ></table ></div >"X7F4046A17BBE64F1" name="X7F4046A17BBE64F1" ></a></p>div class="func" ><table class="func" width="100%" ><tr ><td class="tdleft" ><code class="func" >‣ SetConfirmMessage</code >( <var class="Arg" >IsRequiredArg</var >, <var class="Arg" >IsString</var > )</td td class="tdright" >( operation )</td ></tr ></table ></div >div class="chlinkprevnextbot" > <a href="chap0_mj.html" >[Top of Book]</a> <a href="chap0_mj.html#contents" >[Contents]</a> <a href="chap1_mj.html" >[Previous Chapter]</a> <a href="chap3_mj.html" >[Next Chapter]</a> </div >div class="chlinkbot" ><span class="chlink1" >Goto Chapter: </span ><a href="chap0_mj.html" >Top</a> <a href="chap1_mj.html" >1</a> <a href="chap2_mj.html" >2</a> <a href="chap3_mj.html" >3</a> <a href="chap4_mj.html" >4</a> <a href="chap5_mj.html" >5</a> <a href="chap6_mj.html" >6</a> <a href="chap7_mj.html" >7</a> <a href="chap8_mj.html" >8</a> <a href="chap9_mj.html" >9</a> <a href="chap10_mj.html" >10</a> <a href="chapInd_mj.html" >Ind</a> </div >hr />"foot" >generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc " >GAPDoc2HTML</a></p>body >html >quality 100%
¤ Dauer der Verarbeitung: 0.21 Sekunden
(vorverarbeitet)
¤ *© Formatika GbR, Deutschland
