php-doc-en/reference/newt/functions/newt-button.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.newt-button" xmlns="http://docbook.org/ns/docbook">

 <refnamediv>
  <refname>newt_button</refname>
  <refpurpose>Create a new button</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>newt_button</methodname>
   <methodparam><type>int</type><parameter>left</parameter></methodparam>
   <methodparam><type>int</type><parameter>top</parameter></methodparam>
   <methodparam><type>string</type><parameter>text</parameter></methodparam>
  </methodsynopsis>
  <para>
   Creates a new button.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>left</parameter></term>
     <listitem>
      <para>
       X-coordinate of the button.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>top</parameter></term>
     <listitem>
      <para>
       Y-coordinate of the button.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>text</parameter></term>
     <listitem>
      <para>
       The text which should be displayed in the button.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a resource link to the created button component, or &false; on
   error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>newt_button</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$form = newt_form();

$ok_button = newt_button(5, 12, "Run Tool");
    
newt_form_add_component($form, $ok_button);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>newt_button_bar</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
-->