mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
119 lines
3 KiB
XML
119 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.newt-form-run" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>newt_form_run</refname>
|
|
<refpurpose>Runs a form</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>newt_form_run</methodname>
|
|
<methodparam><type>resource</type><parameter>form</parameter></methodparam>
|
|
<methodparam><type>array</type><parameter role="reference">exit_struct</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function runs the form passed to it.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>form</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Form component
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>exit_struct</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Array, used for returning information after running the form component.
|
|
Keys and values are described in the following table:
|
|
<table>
|
|
<title>Form Exit Structure</title>
|
|
<tgroup cols="3">
|
|
<thead>
|
|
<row>
|
|
<entry>Index Key</entry>
|
|
<entry>Value Type</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>reason</entry>
|
|
<entry>integer</entry>
|
|
<entry>
|
|
The reason, why the form has been exited. Possible values are
|
|
defined <link linkend="constants.newt.reasons">here</link>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>watch</entry>
|
|
<entry>resource</entry>
|
|
<entry>Resource link, specified in
|
|
<function>newt_form_watch_fd</function></entry>
|
|
</row>
|
|
<row>
|
|
<entry>key</entry>
|
|
<entry>integer</entry>
|
|
<entry>Hotkey</entry>
|
|
</row>
|
|
<row>
|
|
<entry>component</entry>
|
|
<entry>resource</entry>
|
|
<entry>Component, which caused the form to exit</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>newt_run_form</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</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
|
|
-->
|