<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Create a form</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.newt-form-watch-fd.html">newt_form_watch_fd</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.newt-get-screen-size.html">newt_get_screen_size</a></div>
<div class="up"><a href="ref.newt.html">Newt Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.newt-form" class="refentry">
<div class="refnamediv">
<h1 class="refname">newt_form</h1>
<p class="verinfo">(PECL newt >= 0.1)</p><p class="refpurpose"><span class="refname">newt_form</span> — <span class="dc-title">Create a form</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.newt-form-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>newt_form</strong></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$vert_bar</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$help</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
]]] )</div>
<p class="para rdfs-comment">
Create a new form.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.newt-form-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">vert_bar</code></em></span>
<dd>
<p class="para">
Vertical scrollbar which should be associated with the form
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">help</code></em></span>
<dd>
<p class="para">
Help text string
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
Various flags
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.newt-form-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a resource link to the created form component, or <strong><code>FALSE</code></strong> on
error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.newt-form-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-639">
<p><strong>Example #1 A <span class="function"><strong>newt_form()</strong></span> example</strong></p>
<div class="example-contents"><p>
Displays a single button "Quit", which closes the application once it's
pressed.
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />newt_init</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">newt_cls</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$myform </span><span style="color: #007700">= </span><span style="color: #0000BB">newt_form</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$button </span><span style="color: #007700">= </span><span style="color: #0000BB">newt_button </span><span style="color: #007700">(</span><span style="color: #0000BB">5</span><span style="color: #007700">, </span><span style="color: #0000BB">12</span><span style="color: #007700">, </span><span style="color: #DD0000">"Quit"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">newt_form_add_component </span><span style="color: #007700">(</span><span style="color: #0000BB">$myform</span><span style="color: #007700">, </span><span style="color: #0000BB">$button</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">newt_refresh </span><span style="color: #007700">();<br /></span><span style="color: #0000BB">newt_run_form </span><span style="color: #007700">(</span><span style="color: #0000BB">$myform</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">newt_finished </span><span style="color: #007700">();<br /></span><span style="color: #0000BB">newt_form_destroy </span><span style="color: #007700">(</span><span style="color: #0000BB">$myform</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.newt-form-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.newt-form-run.html" class="function" rel="rdfs-seeAlso">newt_form_run()</a> - Runs a form</span></li>
<li class="member"> <span class="function"><a href="function.newt-run-form.html" class="function" rel="rdfs-seeAlso">newt_run_form()</a> - Runs a form</span></li>
<li class="member"> <span class="function"><a href="function.newt-form-add-component.html" class="function" rel="rdfs-seeAlso">newt_form_add_component()</a> - Adds a single component to the form</span></li>
<li class="member"> <span class="function"><a href="function.newt-form-add-components.html" class="function" rel="rdfs-seeAlso">newt_form_add_components()</a> - Add several components to the form</span></li>
<li class="member"> <span class="function"><a href="function.newt-form-destroy.html" class="function" rel="rdfs-seeAlso">newt_form_destroy()</a> - Destroys a form</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.newt-form-watch-fd.html">newt_form_watch_fd</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.newt-get-screen-size.html">newt_get_screen_size</a></div>
<div class="up"><a href="ref.newt.html">Newt Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
