doc-en/reference/ui/ui.area.xml at master · php/doc-en · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.ui-area" role="class" 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>
      <simpara>
       Shall be set in the modifiers passed to key and mouse events
       when the <keycap>CTRL</keycap> key is active
      </simpara>
     </listitem>
    </varlistentry>

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

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

</reference>

<!-- 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
-->