Quelle  chap8_mj.html   Sprache: 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"
  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
<title>GAP (Francy) - Chapter 8: Francy Messages</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="chap8"  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="chap7_mj.html">[Previous Chapter]</a>    <a href="chap9_mj.html">[Next Chapter]</a>   </div>

<p id="mathjaxlink" class="pcenter"><a href="chap8.html">[MathJax off]</a></p>
<p><a id="X7B78725D7DF4522F" name="X7B78725D7DF4522F"></a></p>
<div class="ChapSects"><a href="chap8_mj.html#X7B78725D7DF4522F">8 <span class="Heading">Francy Messages</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap8_mj.html#X7CC6903E78F24167">8.1 <span class="Heading">Categories</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X81B6563E7B6AEA6D">8.1-1 IsFrancyMessage</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X7AC1074882D397F6">8.1-2 IsFrancyMessageType</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap8_mj.html#X846063757EC05986">8.2 <span class="Heading">Families</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap8_mj.html#X7EABCC537D3BC549">8.3 <span class="Heading">Representations</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X81FA07417DA0CBF0">8.3-1 IsFrancyMessageRep</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X7A2D43947BDA7E29">8.3-2 IsFrancyMessageTypeRep</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap8_mj.html#X7DE8E16C7C2D387B">8.4 <span class="Heading">Operations</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X7D5DE52179AE8554">8.4-1 FrancyMessage</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap8_mj.html#X8690E870823975F3">8.5 <span class="Heading">Global</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap8_mj.html#X7C701DBF7BAE649A">8.6 <span class="Heading">Attributes</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X84394D1F822EA86F">8.6-1 Title</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X84394D1F822EA86F">8.6-2 Title</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X7A26B9E77D45DC64">8.6-3 SetTitle</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X807A806F83B19870">8.6-4 Value</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X807A806F83B19870">8.6-5 Value</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X7EE61C43853E71CE">8.6-6 SetValue</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X7CCAFAAF79471B9C">8.6-7 Add</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap8_mj.html#X7E9C0B1D855451F4">8.6-8 Remove</a></span>
</div></div>
</div>

<h3>8 <span class="Heading">Francy Messages</span></h3>

<p><code class="code">FrancyMessage</code> is an object that holds a message.</p>

<p>These messages can be used to provide information to users in the form of <code class="code">SUCCESS</code>, <code class="code">INFO</code>, <code class="code">WARNING</code>, <code class="code">ERROR</code>. It is up to the client implementation to handle these messages and their types in a fashionable manner. Please see Francy-JS for client implementation.</p>

<p><a id="X7CC6903E78F24167" name="X7CC6903E78F24167"></a></p>

<h4>8.1 <span class="Heading">Categories</span></h4>

<p>In this section we show all Francy FrancyMessage Categories.</p>

<p><a id="X81B6563E7B6AEA6D" name="X81B6563E7B6AEA6D"></a></p>

<h5>8.1-1 IsFrancyMessage</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; IsFrancyMessage</code>( <var class="Arg">arg</var> )</td><td class="tdright">( filter )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code></p>

<p>Identifies <code class="code">FrancyMessage</code> objects.</p>

<p><a id="X7AC1074882D397F6" name="X7AC1074882D397F6"></a></p>

<h5>8.1-2 IsFrancyMessageType</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; IsFrancyMessageType</code>( <var class="Arg">arg</var> )</td><td class="tdright">( filter )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code></p>

<p>Identifies <code class="code">MessageType</code> objects.</p>

<p><a id="X846063757EC05986" name="X846063757EC05986"></a></p>

<h4>8.2 <span class="Heading">Families</span></h4>

<p>In this section we show all Francy FrancyMessage Families.</p>

<p><a id="X7EABCC537D3BC549" name="X7EABCC537D3BC549"></a></p>

<h4>8.3 <span class="Heading">Representations</span></h4>

<p>In this section we show all Francy FrancyMessage Representations.</p>

<p><a id="X81FA07417DA0CBF0" name="X81FA07417DA0CBF0"></a></p>

<h5>8.3-1 IsFrancyMessageRep</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; IsFrancyMessageRep</code>( <var class="Arg">arg</var> )</td><td class="tdright">( filter )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code></p>

<p>Checks whether an <code class="code">Object</code> has a <code class="code">FrancyMessage</code> internal representation.</p>

<p><a id="X7A2D43947BDA7E29" name="X7A2D43947BDA7E29"></a></p>

<h5>8.3-2 IsFrancyMessageTypeRep</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; IsFrancyMessageTypeRep</code>( <var class="Arg">arg</var> )</td><td class="tdright">( filter )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code></p>

<p>Checks whether an <code class="code">Object</code> has a <code class="code">FrancyMessage</code> internal representation.</p>

<p><a id="X7DE8E16C7C2D387B" name="X7DE8E16C7C2D387B"></a></p>

<h4>8.4 <span class="Heading">Operations</span></h4>

<p>In this section we show all Francy FrancyMessage Operations.</p>

<p><a id="X7D5DE52179AE8554" name="X7D5DE52179AE8554"></a></p>

<h5>8.4-1 FrancyMessage</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; FrancyMessage</code>( <var class="Arg">IsString</var>, <var class="Arg">IsString</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Returns: <code class="code">FrancyMessage</code></p>

<p>Adds an info label with the format "label: value"</p>

<p>Examples:</p>

<p>Create <code class="code">FrancyMessage</code> of all types within a canvas:</p>


<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">canvas := Canvas("Example Canvas / Shape with Messages");</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">graph := Graph(GraphType.HASSE); # will go throughout graphs later</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">shape := Shape(ShapeType.CIRCLE); # will go throughout shapes later</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(graph, shape);</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(canvas, graph);</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(canvas, FrancyMessage(FrancyMessageType.INFO, "Hello"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(shape, FrancyMessage(FrancyMessageType.INFO, "Hello"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(canvas, FrancyMessage(FrancyMessageType.ERROR, "Oops", "Hello"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(shape, FrancyMessage(FrancyMessageType.ERROR, "Oops", "Hello"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(canvas, FrancyMessage(FrancyMessageType.WARNING, "Hello"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(shape, FrancyMessage(FrancyMessageType.WARNING, "Hello"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(canvas, FrancyMessage(FrancyMessageType.SUCCESS, "Hello"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(shape, FrancyMessage(FrancyMessageType.SUCCESS, "Hello"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(canvas, FrancyMessage("Hello", "World"));</span>
<span class="GAPprompt">gap></span> <span class="GAPinput">Add(shape, FrancyMessage("Hello", "World"));</span>
</pre></div>

<p><a id="X8690E870823975F3" name="X8690E870823975F3"></a></p>

<h4>8.5 <span class="Heading">Global</span></h4>

<p>In this section we show all Global FrancyMessage Records for multi purpose.</p>

<p><a id="X7C701DBF7BAE649A" name="X7C701DBF7BAE649A"></a></p>

<h4>8.6 <span class="Heading">Attributes</span></h4>

<p>In this section we show all FrancyMessage Core Attributes</p>

<p><a id="X84394D1F822EA86F" name="X84394D1F822EA86F"></a></p>

<h5>8.6-1 Title</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; Title</code>( <var class="Arg">arg</var> )</td><td class="tdright">( attribute )</td></tr></table></div>
<p>Returns: <code class="code">IsString</code> with the title of the object</p>

<p>A title on a <code class="code">FrancyMessage</code> is used to display the title information to the user.</p>

<p><a id="X84394D1F822EA86F" name="X84394D1F822EA86F"></a></p>

<h5>8.6-2 Title</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; Title</code>( <var class="Arg">arg1</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p><a id="X7A26B9E77D45DC64" name="X7A26B9E77D45DC64"></a></p>

<h5>8.6-3 SetTitle</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; SetTitle</code>( <var class="Arg">IsFrancyMessage</var>, <var class="Arg">IsString</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Sets the title of the <code class="code">FrancyMessage</code>.</p>

<p><a id="X807A806F83B19870" name="X807A806F83B19870"></a></p>

<h5>8.6-4 Value</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; Value</code>( <var class="Arg">arg</var> )</td><td class="tdright">( attribute )</td></tr></table></div>
<p>Returns: <code class="code">IsString</code> with the title of the object</p>

<p>A value on a <code class="code">FrancyMessage</code> is used to display the information to the user.</p>

<p><a id="X807A806F83B19870" name="X807A806F83B19870"></a></p>

<h5>8.6-5 Value</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; Value</code>( <var class="Arg">arg1</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p><a id="X7EE61C43853E71CE" name="X7EE61C43853E71CE"></a></p>

<h5>8.6-6 SetValue</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; SetValue</code>( <var class="Arg">IsFrancyMessage</var>, <var class="Arg">IsString</var> )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Sets the actual message of the <code class="code">FrancyMessage</code>.</p>

<p><a id="X7CCAFAAF79471B9C" name="X7CCAFAAF79471B9C"></a></p>

<h5>8.6-7 Add</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; Add</code>( <var class="Arg">IsFrancyMessage</var>[, <var class="Arg">IsCallback</var>, <var class="Arg">List(IsCallback)</var>] )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Returns: <code class="code">FrancyMessage</code></p>

<p>Add a <code class="code">Callback</code> to a specific <code class="code">FrancyMessage</code>.</p>

<p><a id="X7E9C0B1D855451F4" name="X7E9C0B1D855451F4"></a></p>

<h5>8.6-8 Remove</h5>

<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">&#an style='color: green'>8227; Remove</code>( <var class="Arg">IsFrancyMessage</var>[, <var class="Arg">IsCallback</var>, <var class="Arg">List(IsCallback)</var>] )</td><td class="tdright">( operation )</td></tr></table></div>
<p>Returns: <code class="code">FrancyMessage</code></p>

<p>Remove a <code class="code">Callback</code> from a specific <code class="code">FrancyMessage</code>.</p>


<div class="chlinkprevnextbot"> <a href="chap0_mj.html">[Top of Book]</a>   <a href="chap0_mj.html#contents">[Contents]</a>    <a href="chap7_mj.html">[Previous Chapter]</a>    <a href="chap9_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 />
<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>