php-doc-en/reference/swf/functions/swf-addbuttonrecord.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.swf-addbuttonrecord" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>swf_addbuttonrecord</refname>
  <refpurpose>Controls location, appearance and active area of the current button</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>swf_addbuttonrecord</methodname>
   <methodparam><type>int</type><parameter>states</parameter></methodparam>
   <methodparam><type>int</type><parameter>shapeid</parameter></methodparam>
   <methodparam><type>int</type><parameter>depth</parameter></methodparam>
  </methodsynopsis>
  <para>
   Allow you to define the specifics of using a button.  
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>states</parameter></term>
     <listitem>
      <para>
       Defines what states the button can have, these can be any or all of
       the following constants: <constant>BSHitTest</constant>, 
       <constant>BSDown</constant>, <constant>BSOver</constant> or
       <constant>BSUp</constant>.   
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>shapeid</parameter></term>
     <listitem>
      <para>
       The second parameter, the <parameter>shapeid</parameter> is the look
       of the button, this is usually the object id of the shape of the
       button. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>depth</parameter></term>
     <listitem>
      <para>
       This parameter is the placement of the button in the current frame.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>swf_addbuttonrecord</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
swf_startButton($objid, TYPE_MENUBUTTON);
swf_addButtonRecord(BSDown|BSOver, $buttonImageId, 340);
swf_onCondition(MenuEnter);
swf_actionGetUrl("http://www.example.com", "_level1");
swf_onCondition(MenuExit);
swf_actionGetUrl("", "_level1");
swf_endButton();
?>
]]>
    </programlisting>
   </example>
  </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
-->