php-doc-en/reference/ui/ui.area.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.ui-area" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>Area</title>
 <titleabbrev>UI\Area</titleabbrev>

 <partintro>

<!-- {{{ UI\Area intro -->
  <section xml:id="ui-area.intro">
   &reftitle.intro;
   <para>
    An Area represents a canvas which can be used to draw, and respond to mouse and key events.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="ui-area.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>UI\Area</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>UI\Area</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>UI\Control</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">Constants</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-area.constants.ctrl">UI\Area::Ctrl</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-area.constants.alt">UI\Area::Alt</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-area.constants.shift">UI\Area::Shift</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-area.constants.super">UI\Area::Super</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-area.constants.down">UI\Area::Down</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="ui-area.constants.up">UI\Area::Up</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ui-area')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
    
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.ui-control')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />

   </classsynopsis>
<!-- }}} -->

  </section>
  
<!-- {{{ UI\Area constants -->
  <section xml:id="ui-area.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="ui-area.constants.ctrl">
     <term><constant>UI\Area::Ctrl</constant></term>
     <listitem>
      <para>Shall be set in the modifiers passed to key and mouse events when the CTRL key is active</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="ui-area.constants.alt">
     <term><constant>UI\Area::Alt</constant></term>
     <listitem>
      <para>Shall be set in the modifiers passed to key and mouse events when the ALT key is active</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="ui-area.constants.shift">
     <term><constant>UI\Area::Shift</constant></term>
     <listitem>
      <para>Shall be set in the modifiers passed to key and mouse events when the SHIFT key is active</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="ui-area.constants.super">
     <term><constant>UI\Area::Super</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="ui-area.constants.down">
     <term><constant>UI\Area::Down</constant></term>
     <listitem>
      <para>Shall be set in the modifiers passed to key and mouse events</para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="ui-area.constants.up">
     <term><constant>UI\Area::Up</constant></term>
     <listitem>
      <para>Shall be set in the modifiers passed to key and mouse events</para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.ui.ui.entities.area;

</phpdoc:classref>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->