Help/GUI/guicrucial/ObjectGui.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <title></title>
   7 <meta name="Generator" content="Cocoa HTML Writer">
   8 <meta name="CocoaVersion" content="949.54">
   9 <style type="text/css">
  10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 20.0px Helvetica}
  11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
  12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
  13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 10.0px Monaco; min-height: 14.0px}
  14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 10.0px Monaco}
  15 p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
  16 p.p7 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #00168f}
  17 p.p8 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
  18 p.p9 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco}
  19 p.p10 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #571f0d}
  20 p.p11 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #571f0d; min-height: 12.0px}
  21 span.s1 {color: #000000}
  22 span.s2 {color: #00168f}
  23 span.s3 {color: #571f0d}
  24 span.Apple-tab-span {white-space:pre}
  25 </style>
  26 </head>
  27 <body>
  28 <p class="p1"><b>ObjectGui</b></p>
  29 <p class="p2"><br></p>
  30 <p class="p3"><b>superclass for all Gui classes</b></p>
  31 <p class="p2"><br></p>
  32 <p class="p3">In the MVC architecture this is the Controller, which creates Views for manipulating the properties of your Model, and receives messages from the View and enacts the changes on the Model.</p>
  33 <p class="p2"><br></p>
  34 <p class="p3">Each class specifies its Gui class via the guiClass method.</p>
  35 <p class="p2"><br></p>
  36 <p class="p3">The default guiClass for an Object is ObjectGui.<span class="Apple-converted-space">  </span>So if a class does not implement guiClass at all, then at least there is a default ObjectGui that will display the name.</p>
  37 <p class="p2"><br></p>
  38 <p class="p3">Many subclasses overide the <b>guiClass</b> method to specify a different class, one that subclasses ObjectGui.</p>
  39 <p class="p4"><br></p>
  40 <p class="p5">see [gui]</p>
  41 <p class="p2"><br></p>
  42 <p class="p3">It is the simplest display, just the the object asString.</p>
  43 <p class="p2"><br></p>
  44 <p class="p2"><br></p>
  45 <p class="p2"><br></p>
  46 <p class="p2"><br></p>
  47 <p class="p6"><b>an example gui class</b></p>
  48 <p class="p4"><br></p>
  49 <p class="p7">YourSimpleGuiClass<span class="s1"> : </span>ObjectGui<span class="s1"> {</span></p>
  50 <p class="p8"><br></p>
  51 <p class="p9"><span class="Apple-tab-span">     </span>guiBody { <span class="s2">arg</span> layout;</p>
  52 <p class="p8"><span class="Apple-tab-span">     </span></p>
  53 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// we refer to the model and</p>
  54 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// access its variable howFast.</p>
  55 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// if its a simple number, it will display</p>
  56 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// using the default ObjectGui class, which</p>
  57 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// will simply show its value as a string.</p>
  58 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>model.howFast.gui(layout);</p>
  59 <p class="p9"><span class="Apple-tab-span">     </span>}</p>
  60 <p class="p9">}</p>
  61 <p class="p8"><br></p>
  62 <p class="p8"><br></p>
  63 <p class="p10">// more complex</p>
  64 <p class="p7">YourGuiClass<span class="s1"> : </span>ObjectGui<span class="s1"> {</span></p>
  65 <p class="p8"><span class="Apple-tab-span">     </span></p>
  66 <p class="p9"><span class="Apple-tab-span">     </span><span class="s2">var</span> numberEditor;</p>
  67 <p class="p8"><span class="Apple-tab-span">     </span></p>
  68 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span></span>//for example</p>
  69 <p class="p9"><span class="Apple-tab-span">     </span>guiBody { <span class="s2">arg</span> layout;</p>
  70 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="s2">var</span> r;</p>
  71 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// the object you are making a gui for is referred to as the model</p>
  72 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  73 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// display some param on screen.</p>
  74 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// here we assume that someParam is something that</p>
  75 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>//<span class="Apple-converted-space">  </span>has a suitable gui class</p>
  76 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// implemented, or that the default ObjectGui is sufficient.</p>
  77 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>model.someParam.gui(layout);</p>
  78 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  79 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span></span>// using non 'gui' objects</p>
  80 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>r = layout.layRight(300,300); <span class="s3">// allocate yourself some space</span></p>
  81 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="s2">Button</span>(layout.win,r)</p>
  82 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>.action_({ <span class="s2">arg</span> butt;</p>
  83 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>model.goApeShit;</p>
  84 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>});</p>
  85 <p class="p8"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span></p>
  86 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>// note: NumberEditor is a cruciallib class</p>
  87 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>numberEditor = <span class="s2">NumberEditor</span>(model.howFast,[0,100])</p>
  88 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>.action_({ <span class="s2">arg</span> val;<span class="Apple-converted-space"> </span></p>
  89 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>model.howFast = val;<span class="Apple-converted-space"> </span></p>
  90 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>model.changed(<span class="s2">this</span>);<span class="Apple-converted-space"> </span></p>
  91 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></span>// tell the model that this gui changed it</p>
  92 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>});</p>
  93 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>numberEditor.gui(layout);</p>
  94 <p class="p9"><span class="Apple-tab-span">     </span>}</p>
  95 <p class="p8"><span class="Apple-tab-span">     </span></p>
  96 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span></span>// your gui object will have update called any time the .changed message</p>
  97 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span></span>// is sent to your model</p>
  98 <p class="p9"><span class="Apple-tab-span">     </span>update { <span class="s2">arg</span> changed,changer;</p>
  99 <p class="p8"><span class="Apple-tab-span">     </span></p>
 100 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>if(changer !== <span class="s2">this</span>,{<span class="Apple-converted-space"> </span></p>
 101 <p class="p10"><span class="s1"><span class="Apple-tab-span">   </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span></span>/* if it is this gui object that changed the value</p>
 102 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>using the numberEditor, then we already have a correct</p>
 103 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>display and don't need to waste cpu to update it.</p>
 104 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>if anyone else changed anything about the model,</p>
 105 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>we will update ourselves here.</p>
 106 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>*/</p>
 107 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>numberEditor.value = model.howFast;</p>
 108 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="s3">/*</span></p>
 109 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>note that<span class="Apple-converted-space"> </span></p>
 110 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>numberEditor.value = model.howFast;</p>
 111 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>is passive, and does not fire the numberEditor's action.<span class="Apple-tab-span">    </span></p>
 112 <p class="p11"><br></p>
 113 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>numberEditor.activeValue = model.howFast</p>
 114 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>would fire the action as well, resulting in a loop that would</p>
 115 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>probably crash your machine.</p>
 116 <p class="p10"><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span><span class="Apple-tab-span">    </span>*/</p>
 117 <p class="p9"><span class="Apple-tab-span">     </span><span class="Apple-tab-span">    </span>}</p>
 118 <p class="p9"><span class="Apple-tab-span">     </span>}</p>
 119 <p class="p8"><br></p>
 120 <p class="p9">}</p>
 121 <p class="p8"><br></p>
 122 <p class="p8"><br></p>
 123 </body>
 124 </html>