cvs: peardoc /peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook addformat.xml addworksheet.xml close.xml setcustomcolor.xml
| From: | Xavier Noguer Gallego | Date: | Mon, 20 Jan 2003 18:42:32 +0000 |
| Subject: | cvs: peardoc /peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook addformat.xml addworksheet.xml close.xml setcustomcolor.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-293@lists.php.net to get a copy of this message | ||
xnoguer Mon Jan 20 13:42:32 2003 EDT
Added files:
/peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook
addformat.xml
addworksheet.xml
close.xml
setcustomcolor.xml
Log:
first version of docs
Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/addformat.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/addformat.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.workbook.addformat"> <refnamediv> <refname>Workbook::&addFormat</refname> <refpurpose>Add a new format to the Excel workbook.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once "Spreadsheet/Excel/Writer.php"; </funcsynopsisinfo> <funcprototype> <funcdef>object reference <function>Workbook::&addFormat</function></funcdef> <paramdef> array <parameter><optional>$properties=array()</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.desc"> &title.desc; <para> Add a new format to the Excel workbook. Also, pass any properties to the Format constructor. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>array $properties</parameter> - array with properties for initializing the format (see Format.php) </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.return"> &title.returns; <para> <parameter>object reference</parameter> - to an XF format </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.note"> &title.note; ¬e.notstatic; <simpara></simpara> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.example"> &title.example; <example> <title>Using <function>&addFormat</function></title> <programlisting role="php"> <![CDATA[ ]]> </programlisting> </example> </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 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 --> Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/addworksheet.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/addworksheet.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet"> <refnamediv> <refname>Workbook::&addWorksheet</refname> <refpurpose>Add a new worksheet to the Excel workbook.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once "Spreadsheet/Excel/Writer.php"; </funcsynopsisinfo> <funcprototype> <funcdef>object reference <function>Workbook::&addWorksheet</function></funcdef> <paramdef> string <parameter><optional>$name=''</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.desc"> &title.desc; <para> Add a new worksheet to the Excel workbook. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $name</parameter> - the optional name of the worksheet </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.return"> &title.returns; <para> <parameter>object reference</parameter> - to a worksheet object </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.note"> &title.note; ¬e.notstatic; <simpara></simpara> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.example"> &title.example; <example> <title>Using <function>&addWorksheet</function></title> <programlisting role="php"> <![CDATA[ ]]> </programlisting> </example> </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 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 --> Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/close.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/close.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.workbook.close"> <refnamediv> <refname>Workbook::close</refname> <refpurpose>Calls finalization methods and explicitly close the OLEwriter file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once "Spreadsheet/Excel/Writer.php"; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Workbook::close</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.close.desc"> &title.desc; <para> Calls finalization methods and explicitly close the OLEwriter file handle. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.close.note"> &title.note; ¬e.notstatic; <simpara></simpara> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.close.example"> &title.example; <example> <title>Using <function>close</function></title> <programlisting role="php"> <![CDATA[ ]]> </programlisting> </example> </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 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 --> Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/setcustomcolor.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/setcustomcolor.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor"> <refnamediv> <refname>Workbook::setCustomColor</refname> <refpurpose>Change the RGB components of the elements in the colour palette.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once "Spreadsheet/Excel/Writer.php"; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>Workbook::setCustomColor</function></funcdef> <paramdef> integer <parameter>$index</parameter> </paramdef> <paramdef> integer <parameter>$red</parameter> </paramdef> <paramdef> integer <parameter>$green</parameter> </paramdef> <paramdef> integer <parameter>$blue</parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.desc"> &title.desc; <para> Change the RGB components of the elements in the colour palette. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>integer $index</parameter> - colour index </para> </listitem> <listitem> <para> <parameter>integer $red</parameter> - red RGB value [0-255] </para> </listitem> <listitem> <para> <parameter>integer $green</parameter> - green RGB value [0-255] </para> </listitem> <listitem> <para> <parameter>integer $blue</parameter> - blue RGB value [0-255] </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.return"> &title.returns; <para> <parameter>integer</parameter> - The palette index for the custom color </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.note"> &title.note; ¬e.notstatic; <simpara></simpara> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.example"> &title.example; <example> <title>Using <function>setCustomColor</function></title> <programlisting role="php"> <![CDATA[ ]]> </programlisting> </example> </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 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 -->
Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/addformat.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/addformat.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.workbook.addformat"> <refnamediv> <refname>Workbook::&addFormat</refname> <refpurpose>Add a new format to the Excel workbook.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once "Spreadsheet/Excel/Writer.php"; </funcsynopsisinfo> <funcprototype> <funcdef>object reference <function>Workbook::&addFormat</function></funcdef> <paramdef> array <parameter><optional>$properties=array()</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.desc"> &title.desc; <para> Add a new format to the Excel workbook. Also, pass any properties to the Format constructor. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>array $properties</parameter> - array with properties for initializing the format (see Format.php) </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.return"> &title.returns; <para> <parameter>object reference</parameter> - to an XF format </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.note"> &title.note; ¬e.notstatic; <simpara></simpara> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addformat.example"> &title.example; <example> <title>Using <function>&addFormat</function></title> <programlisting role="php"> <![CDATA[ ]]> </programlisting> </example> </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 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 --> Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/addworksheet.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/addworksheet.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet"> <refnamediv> <refname>Workbook::&addWorksheet</refname> <refpurpose>Add a new worksheet to the Excel workbook.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once "Spreadsheet/Excel/Writer.php"; </funcsynopsisinfo> <funcprototype> <funcdef>object reference <function>Workbook::&addWorksheet</function></funcdef> <paramdef> string <parameter><optional>$name=''</optional></parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.desc"> &title.desc; <para> Add a new worksheet to the Excel workbook. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $name</parameter> - the optional name of the worksheet </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.return"> &title.returns; <para> <parameter>object reference</parameter> - to a worksheet object </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.note"> &title.note; ¬e.notstatic; <simpara></simpara> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.addworksheet.example"> &title.example; <example> <title>Using <function>&addWorksheet</function></title> <programlisting role="php"> <![CDATA[ ]]> </programlisting> </example> </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 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 --> Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/close.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/close.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.workbook.close"> <refnamediv> <refname>Workbook::close</refname> <refpurpose>Calls finalization methods and explicitly close the OLEwriter file</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once "Spreadsheet/Excel/Writer.php"; </funcsynopsisinfo> <funcprototype> <funcdef>void <function>Workbook::close</function></funcdef> <paramdef></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.close.desc"> &title.desc; <para> Calls finalization methods and explicitly close the OLEwriter file handle. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.close.note"> &title.note; ¬e.notstatic; <simpara></simpara> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.close.example"> &title.example; <example> <title>Using <function>close</function></title> <programlisting role="php"> <![CDATA[ ]]> </programlisting> </example> </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 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 --> Index: peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/setcustomcolor.xml +++ peardoc/peardoc2/en/package/fileformats/spreadsheet-excel-writer/workbook/setcustomcolor.xml <!-- $Revision: 1.1 $ --> <refentry id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor"> <refnamediv> <refname>Workbook::setCustomColor</refname> <refpurpose>Change the RGB components of the elements in the colour palette.</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once "Spreadsheet/Excel/Writer.php"; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>Workbook::setCustomColor</function></funcdef> <paramdef> integer <parameter>$index</parameter> </paramdef> <paramdef> integer <parameter>$red</parameter> </paramdef> <paramdef> integer <parameter>$green</parameter> </paramdef> <paramdef> integer <parameter>$blue</parameter> </paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.desc"> &title.desc; <para> Change the RGB components of the elements in the colour palette. </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.parameter"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>integer $index</parameter> - colour index </para> </listitem> <listitem> <para> <parameter>integer $red</parameter> - red RGB value [0-255] </para> </listitem> <listitem> <para> <parameter>integer $green</parameter> - green RGB value [0-255] </para> </listitem> <listitem> <para> <parameter>integer $blue</parameter> - blue RGB value [0-255] </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.return"> &title.returns; <para> <parameter>integer</parameter> - The palette index for the custom color </para> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.note"> &title.note; ¬e.notstatic; <simpara></simpara> </refsect1> <refsect1 id="package.fileformats.spreadsheet-excel-writer.workbook.setcustomcolor.example"> &title.example; <example> <title>Using <function>setCustomColor</function></title> <programlisting role="php"> <![CDATA[ ]]> </programlisting> </example> </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 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 -->