<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.ui.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'de',
  ),
  'this' => 
  array (
    0 => 'class.ui-area.php',
    1 => 'UI\\Area',
    2 => 'Area',
  ),
  'up' => 
  array (
    0 => 'book.ui.php',
    1 => 'UI',
  ),
  'prev' => 
  array (
    0 => 'ui-menuitem.setchecked.php',
    1 => 'UI\\MenuItem::setChecked',
  ),
  'next' => 
  array (
    0 => 'ui-area.ondraw.php',
    1 => 'UI\\Area::onDraw',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ui/ui.area.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.ui-area.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.ui-area" class="reference">

 <h1 class="title">Area</h1>
 

 <div class="partintro"><p class="verinfo">(UI 0.9.9)</p>


  <div class="section" id="ui-area.intro">
   <h2 class="title">Einführung</h2>
   <p class="para">
    An Area represents a canvas which can be used to draw, and respond to mouse and key events.
   </p>
  </div>


  <div class="section" id="ui-area.synopsis">
   <h2 class="title">Klassenbeschreibung</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">UI\Area</strong>
     </span>

     <span class="ooclass">
      <span class="modifier">extends</span>
       <a href="class.ui-control.php" class="classname">UI\Control</a>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Konstanten */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.ui-area.php#ui-area.constants.ctrl"><var class="varname">Ctrl</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.ui-area.php#ui-area.constants.alt"><var class="varname">Alt</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.ui-area.php#ui-area.constants.shift"><var class="varname">Shift</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.ui-area.php#ui-area.constants.super"><var class="varname">Super</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.ui-area.php#ui-area.constants.down"><var class="varname">Down</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.ui-area.php#ui-area.constants.up"><var class="varname">Up</var></a></var>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methoden */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">protected</span> <span class="methodname"><a href="ui-area.ondraw.php" class="methodname">onDraw</a></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.ui-draw-pen.php" class="type UI\Draw\Pen">UI\Draw\Pen</a></span> <code class="parameter">$pen</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.ui-size.php" class="type UI\Size">UI\Size</a></span> <code class="parameter">$areaSize</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.ui-point.php" class="type UI\Point">UI\Point</a></span> <code class="parameter">$clipPoint</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.ui-size.php" class="type UI\Size">UI\Size</a></span> <code class="parameter">$clipSize</code></span><br>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">protected</span> <span class="methodname"><a href="ui-area.onkey.php" class="methodname">onKey</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$key</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$ext</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">protected</span> <span class="methodname"><a href="ui-area.onmouse.php" class="methodname">onMouse</a></span>(<span class="methodparam"><span class="type"><a href="class.ui-point.php" class="type UI\Point">UI\Point</a></span> <code class="parameter">$areaPoint</code></span>, <span class="methodparam"><span class="type"><a href="class.ui-size.php" class="type UI\Size">UI\Size</a></span> <code class="parameter">$areaSize</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-area.redraw.php" class="methodname">redraw</a></span>()</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-area.scrollto.php" class="methodname">scrollTo</a></span>(<span class="methodparam"><span class="type"><a href="class.ui-point.php" class="type UI\Point">UI\Point</a></span> <code class="parameter">$point</code></span>, <span class="methodparam"><span class="type"><a href="class.ui-size.php" class="type UI\Size">UI\Size</a></span> <code class="parameter">$size</code></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-area.setsize.php" class="methodname">setSize</a></span>(<span class="methodparam"><span class="type"><a href="class.ui-size.php" class="type UI\Size">UI\Size</a></span> <code class="parameter">$size</code></span>)</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Geerbte Methoden */</div>
    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.destroy.php" class="methodname">UI\Control::destroy</a></span>()</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.disable.php" class="methodname">UI\Control::disable</a></span>()</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.enable.php" class="methodname">UI\Control::enable</a></span>()</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.getparent.php" class="methodname">UI\Control::getParent</a></span>(): <span class="type"><a href="class.ui-control.php" class="type UI\Control">UI\Control</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.gettoplevel.php" class="methodname">UI\Control::getTopLevel</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.hide.php" class="methodname">UI\Control::hide</a></span>()</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.isenabled.php" class="methodname">UI\Control::isEnabled</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.isvisible.php" class="methodname">UI\Control::isVisible</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.setparent.php" class="methodname">UI\Control::setParent</a></span>(<span class="methodparam"><span class="type"><a href="class.ui-control.php" class="type UI\Control">UI\Control</a></span> <code class="parameter">$parent</code></span>)</div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ui-control.show.php" class="methodname">UI\Control::show</a></span>()</div>


   }</div>


  </div>


  <div class="section" id="ui-area.constants">
   <h2 class="title">Vordefinierte Konstanten</h2>
   <dl>

    
     <dt id="ui-area.constants.ctrl"><strong><code><a href="class.ui-area.php#ui-area.constants.ctrl">UI\Area::Ctrl</a></code></strong></dt>
     <dd>
      <span class="simpara">
       Shall be set in the modifiers passed to key and mouse events
       when the <kbd class="keycap">CTRL</kbd> key is active
      </span>
     </dd>
    

    
     <dt id="ui-area.constants.alt"><strong><code><a href="class.ui-area.php#ui-area.constants.alt">UI\Area::Alt</a></code></strong></dt>
     <dd>
      <span class="simpara">
       Shall be set in the modifiers passed to key and mouse events
       when the <kbd class="keycap">ALT</kbd> key is active
      </span>
     </dd>
    

    
     <dt id="ui-area.constants.shift"><strong><code><a href="class.ui-area.php#ui-area.constants.shift">UI\Area::Shift</a></code></strong></dt>
     <dd>
      <span class="simpara">
       Shall be set in the modifiers passed to key and mouse events
       when the <kbd class="keycap">SHIFT</kbd> key is active
      </span>
     </dd>
    

    
     <dt id="ui-area.constants.super"><strong><code><a href="class.ui-area.php#ui-area.constants.super">UI\Area::Super</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="ui-area.constants.down"><strong><code><a href="class.ui-area.php#ui-area.constants.down">UI\Area::Down</a></code></strong></dt>
     <dd>
      <p class="para">Shall be set in the modifiers passed to key and mouse events</p>
     </dd>
    

    
     <dt id="ui-area.constants.up"><strong><code><a href="class.ui-area.php#ui-area.constants.up">UI\Area::Up</a></code></strong></dt>
     <dd>
      <p class="para">Shall be set in the modifiers passed to key and mouse events</p>
     </dd>
    

   </dl>
  </div>



 </div>

 










































<h2>Inhaltsverzeichnis</h2><ul class="chunklist chunklist_reference"><li><a href="ui-area.ondraw.php">UI\Area::onDraw</a> — Draw Callback</li><li><a href="ui-area.onkey.php">UI\Area::onKey</a> — Key Callback</li><li><a href="ui-area.onmouse.php">UI\Area::onMouse</a> — Mouse Callback</li><li><a href="ui-area.redraw.php">UI\Area::redraw</a> — Redraw Area</li><li><a href="ui-area.scrollto.php">UI\Area::scrollTo</a> — Area Scroll</li><li><a href="ui-area.setsize.php">UI\Area::setSize</a> — Set Size</li></ul>
</div>
<?php manual_footer($setup); ?>