php-doc-en/reference/ming/swfbutton/addshape.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.swfbutton.addshape" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>SWFButton->addShape</refname>
  <refpurpose>Adds a shape to a button</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>SWFButton</classname></ooclass>
   <methodsynopsis>
    <type>void</type><methodname>addShape</methodname>
    <methodparam><type>SWFShape</type><parameter>shape</parameter></methodparam>
    <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
  &warn.experimental.func;
  <para>
   Adds the given <parameter>shape</parameter> to the button. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>shape</parameter></term>
     <listitem>
      <para>
       An <classname>SWFShape</classname> instance
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       The following <parameter>flags</parameter> are valid: 
       <constant>SWFBUTTON_UP</constant>, 
       <constant>SWFBUTTON_OVER</constant>, 
       <constant>SWFBUTTON_DOWN</constant> and
       <constant>SWFBUTTON_HIT</constant>.
      </para>
      <para>
       <constant>SWFBUTTON_HIT</constant> isn't ever displayed, it defines
       the hit region for the button. That is, everywhere the hit shape would
       be drawn is considered a "touchable" part of the button. 
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </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
-->