updates for 1.0.0

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@340652 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Joe Watkins 2016-10-25 08:05:46 +00:00
parent 0625a2700b
commit 372fd14f6f
11 changed files with 345 additions and 301 deletions

View file

@ -64,6 +64,7 @@
&reference.ui.ui.draw.text.font.stretch;
&reference.ui.ui.draw.line.cap;
&reference.ui.ui.draw.line.join;
&reference.ui.ui.key;
</book>
<!-- Keep this comment at the end of the file

View file

@ -36,53 +36,23 @@
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-line-cap.constants.flat">UI\Draw\Line\Cap::Flat</varname>
<varname>UI\Draw\Line\Cap::Flat</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-line-cap.constants.round">UI\Draw\Line\Cap::Round</varname>
<varname>UI\Draw\Line\Cap::Round</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-line-cap.constants.square">UI\Draw\Line\Cap::Square</varname>
<varname>UI\Draw\Line\Cap::Square</varname>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ UI\Draw\Line\Cap constants -->
<section xml:id="ui-draw-line-cap.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="ui-draw-line-cap.constants.flat">
<term><constant>UI\Draw\Line\Cap::Flat</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-line-cap.constants.round">
<term><constant>UI\Draw\Line\Cap::Round</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-line-cap.constants.square">
<term><constant>UI\Draw\Line\Cap::Square</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>

View file

@ -36,54 +36,23 @@
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-line-join.constants.miter">UI\Draw\Line\Join::Miter</varname>
<varname>UI\Draw\Line\Join::Miter</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-line-join.constants.round">UI\Draw\Line\Join::Round</varname>
<varname>UI\Draw\Line\Join::Round</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-line-join.constants.bevel">UI\Draw\Line\Join::Bevel</varname>
<varname>UI\Draw\Line\Join::Bevel</varname>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ UI\Draw\Line\Join constants -->
<section xml:id="ui-draw-line-join.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="ui-draw-line-join.constants.miter">
<term><constant>UI\Draw\Line\Join::Miter</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-line-join.constants.round">
<term><constant>UI\Draw\Line\Join::Round</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-line-join.constants.bevel">
<term><constant>UI\Draw\Line\Join::Bevel</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>

View file

@ -36,19 +36,19 @@
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-italic.constants.normal">UI\Draw\Text\Font\Italic::Normal</varname>
<varname>UI\Draw\Text\Font\Italic::Normal</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-italic.constants.oblique">UI\Draw\Text\Font\Italic::Oblique</varname>
<varname>UI\Draw\Text\Font\Italic::Oblique</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-italic.constants.italic">UI\Draw\Text\Font\Italic::Italic</varname>
<varname>UI\Draw\Text\Font\Italic::Italic</varname>
<initializer>2</initializer>
</fieldsynopsis>
@ -56,37 +56,6 @@
<!-- }}} -->
</section>
<!-- {{{ UI\Draw\Text\Font\Italic constants -->
<section xml:id="ui-draw-text-font-italic.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="ui-draw-text-font-italic.constants.normal">
<term><constant>UI\Draw\Text\Font\Italic::Normal</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-italic.constants.oblique">
<term><constant>UI\Draw\Text\Font\Italic::Oblique</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-italic.constants.italic">
<term><constant>UI\Draw\Text\Font\Italic::Italic</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>

View file

@ -36,55 +36,55 @@
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.ultracondensed">UI\Draw\Text\Font\Stretch::UltraCondensed</varname>
<varname>UI\Draw\Text\Font\Stretch::UltraCondensed</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.extracondensed">UI\Draw\Text\Font\Stretch::ExtraCondensed</varname>
<varname>UI\Draw\Text\Font\Stretch::ExtraCondensed</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.condensed">UI\Draw\Text\Font\Stretch::Condensed</varname>
<varname>UI\Draw\Text\Font\Stretch::Condensed</varname>
<initializer>2</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.semicondensed">UI\Draw\Text\Font\Stretch::SemiCondensed</varname>
<varname>UI\Draw\Text\Font\Stretch::SemiCondensed</varname>
<initializer>3</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.normal">UI\Draw\Text\Font\Stretch::Normal</varname>
<varname>UI\Draw\Text\Font\Stretch::Normal</varname>
<initializer>4</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.semiexpanded">UI\Draw\Text\Font\Stretch::SemiExpanded</varname>
<varname>UI\Draw\Text\Font\Stretch::SemiExpanded</varname>
<initializer>5</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.expanded">UI\Draw\Text\Font\Stretch::Expanded</varname>
<varname>UI\Draw\Text\Font\Stretch::Expanded</varname>
<initializer>6</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.extraexpanded">UI\Draw\Text\Font\Stretch::ExtraExpanded</varname>
<varname>UI\Draw\Text\Font\Stretch::ExtraExpanded</varname>
<initializer>7</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-stretch.constants.ultraexpanded">UI\Draw\Text\Font\Stretch::UltraExpanded</varname>
<varname>UI\Draw\Text\Font\Stretch::UltraExpanded</varname>
<initializer>8</initializer>
</fieldsynopsis>
@ -92,79 +92,6 @@
<!-- }}} -->
</section>
<!-- {{{ UI\Draw\Text\Font\Stretch constants -->
<section xml:id="ui-draw-text-font-stretch.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.ultracondensed">
<term><constant>UI\Draw\Text\Font\Stretch::UltraCondensed</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.extracondensed">
<term><constant>UI\Draw\Text\Font\Stretch::ExtraCondensed</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.condensed">
<term><constant>UI\Draw\Text\Font\Stretch::Condensed</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.semicondensed">
<term><constant>UI\Draw\Text\Font\Stretch::SemiCondensed</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.normal">
<term><constant>UI\Draw\Text\Font\Stretch::Normal</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.semiexpanded">
<term><constant>UI\Draw\Text\Font\Stretch::SemiExpanded</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.expanded">
<term><constant>UI\Draw\Text\Font\Stretch::Expanded</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.extraexpanded">
<term><constant>UI\Draw\Text\Font\Stretch::ExtraExpanded</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-stretch.constants.ultraexpanded">
<term><constant>UI\Draw\Text\Font\Stretch::UltraExpanded</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>

View file

@ -36,150 +36,63 @@
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.thin">UI\Draw\Text\Font\Weight::Thin</varname>
<varname>UI\Draw\Text\Font\Weight::Thin</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.ultralight">UI\Draw\Text\Font\Weight::UltraLight</varname>
<varname>UI\Draw\Text\Font\Weight::UltraLight</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.light">UI\Draw\Text\Font\Weight::Light</varname>
<varname>UI\Draw\Text\Font\Weight::Light</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.book">UI\Draw\Text\Font\Weight::Book</varname>
<varname>UI\Draw\Text\Font\Weight::Book</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.normal">UI\Draw\Text\Font\Weight::Normal</varname>
<varname>UI\Draw\Text\Font\Weight::Normal</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.medium">UI\Draw\Text\Font\Weight::Medium</varname>
<varname>UI\Draw\Text\Font\Weight::Medium</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.semibold">UI\Draw\Text\Font\Weight::SemiBold</varname>
<varname>UI\Draw\Text\Font\Weight::SemiBold</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.bold">UI\Draw\Text\Font\Weight::Bold</varname>
<varname>UI\Draw\Text\Font\Weight::Bold</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.ultrabold">UI\Draw\Text\Font\Weight::UltraBold</varname>
<varname>UI\Draw\Text\Font\Weight::UltraBold</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.heavy">UI\Draw\Text\Font\Weight::Heavy</varname>
<varname>UI\Draw\Text\Font\Weight::Heavy</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="ui-draw-text-font-weight.constants.ultraheavy">UI\Draw\Text\Font\Weight::UltraHeavy</varname>
<varname>UI\Draw\Text\Font\Weight::UltraHeavy</varname>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ UI\Draw\Text\Font\Weight constants -->
<section xml:id="ui-draw-text-font-weight.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="ui-draw-text-font-weight.constants.thin">
<term><constant>UI\Draw\Text\Font\Weight::Thin</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.ultralight">
<term><constant>UI\Draw\Text\Font\Weight::UltraLight</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.light">
<term><constant>UI\Draw\Text\Font\Weight::Light</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.book">
<term><constant>UI\Draw\Text\Font\Weight::Book</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.normal">
<term><constant>UI\Draw\Text\Font\Weight::Normal</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.medium">
<term><constant>UI\Draw\Text\Font\Weight::Medium</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.semibold">
<term><constant>UI\Draw\Text\Font\Weight::SemiBold</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.bold">
<term><constant>UI\Draw\Text\Font\Weight::Bold</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.ultrabold">
<term><constant>UI\Draw\Text\Font\Weight::UltraBold</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.heavy">
<term><constant>UI\Draw\Text\Font\Weight::Heavy</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry xml:id="ui-draw-text-font-weight.constants.ultraheavy">
<term><constant>UI\Draw\Text\Font\Weight::UltraHeavy</constant></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>

260
reference/ui/ui.key.xml Normal file
View file

@ -0,0 +1,260 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.ui-key" 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>Key Identifiers</title>
<titleabbrev>UI\Key</titleabbrev>
<partintro>
<!-- {{{ UI\Key intro -->
<section xml:id="ui-key.intro">
&reftitle.intro;
<para>
</para>
</section>
<!-- }}} -->
<section xml:id="ui-key.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>UI\Key</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<modifier>final</modifier>
<classname>UI\Key</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::Escape</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::Insert</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::Delete</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::Home</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::End</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::PageUp</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::PageDown</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::Up</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::Down</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::Left</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::Right</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F1</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F2</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F3</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F4</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F5</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F6</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F7</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F8</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F9</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F10</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F11</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::F12</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N0</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N1</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N2</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N3</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N4</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N5</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N6</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N7</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N8</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::N9</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::NDot</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::NEnter</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::NAdd</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::NSubtract</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::NMultiply</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname>UI\Key::NDivide</varname>
</fieldsynopsis>
</classsynopsis>
<!-- }}} -->
</section>
</partintro>
</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
-->

View file

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ui-app.ontick" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>UI\App::onTick</refname>
<refpurpose>Tick Callback</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>protected</modifier> <methodname>UI\App::onTick</methodname>
<void/>
</methodsynopsis>
<para>
Should be executed by the main loop as appropriate
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
</refentry>
<!-- 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
-->

View file

@ -11,8 +11,7 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <methodname>UI\App::run</methodname>
<methodparam choice="opt"><type>boolean</type><parameter>loop</parameter></methodparam>
<methodparam choice="opt"><type>boolean</type><parameter>block</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Will cause the App to enter into the main loop, by default control will not be returned to the caller
@ -24,32 +23,16 @@
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>loop</parameter></term>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Should be true if the calling script requires control to be returned so that it may loop
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>block</parameter></term>
<listitem>
<para>
Used when loop is true to determine if the call to run should block
Should set App::Loop if control should be returned, should set App::Wait if control should be returned after waiting
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

View file

@ -1,3 +1,4 @@
&reference.ui.ui.app.onshouldquit;
&reference.ui.ui.app.ontick;
&reference.ui.ui.app.quit;
&reference.ui.ui.app.run;

View file

@ -13,6 +13,7 @@
<function name='ui\app::run' from='PHP 7, UI 0.9.9'/>
<function name='ui\app::quit' from='PHP 7, UI 0.9.9'/>
<function name='ui\app::onshouldquit' from='PHP 7, UI 0.9.9'/>
<function name='ui\app::ontick' from='PHP 7, UI 1.0.0'/>
<function name='ui\point' from='PHP 7, UI 0.9.9'/>
<function name='ui\point::__construct' from='PHP 7, UI 0.9.9'/>
@ -484,6 +485,8 @@
<function name='ui\draw\text\layout::__construct' from='PHP 7, UI 0.9.9'/>
<function name='ui\draw\text\layout::setwidth' from='PHP 7, UI 0.9.9'/>
<function name='ui\draw\text\layout::setcolor' from='PHP 7, UI 0.9.9'/>
<function name='ui\key' from='PHP 7, UI 1.0.0'/>
</versions>
<!-- Keep this comment at the end of the file