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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.newt-form-run">
<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="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:"../../../../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
-->
|
