cvs: peardoc /en/package/structures/structures-datagrid/structures-datagrid addcolumn.xml

asnagy Fri Jan 28 10:30:11 2005 EDT Modified files: /peardoc/en/package/structures/structures-datagrid/structures-datagrid addcolumn.xml Log: Added parameter and example sections http://cvs.php.net/diff.php/peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml?r1=1.1&r2=1.2&ty=u Index: peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml diff -u peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml:1.1 peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml:1.2 --- peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml:1.1 Fri Dec 10 16:02:06 2004 +++ peardoc/en/package/structures/structures-datagrid/structures-datagrid/addcolumn.xml Fri Jan 28 10:30:10 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="package.structures.structures_datagrid.structures_datagrid.addcolumn"> <refnamediv> @@ -25,10 +25,49 @@ This method is used to add a Structures_DataGrid_Column object to the DataGrid's Column Collection. If no columns are added to the collection, the DataGrid will attempt to use it's own column names that can be gathered - from the data set. + from the data set. However, once you use this method, the DataGrid will no + longer attempt to auto-generate columns for you. </para> </refsect1> + <refsect1 id="package.structures.structures_datagrid.structures_datagrid.addcolumn.parameter"> + &title.param; + <para> + <variablelist> + <varlistentry> + <term> + <classname>Structures_DataGrid_Column</classname> + <parameter>$column</parameter> + </term> + <listitem> + <para> + The &class.structures-datagrid-column object to be defined. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 id="package.structures.structures_datagrid.structures_datagrid.addcolumn.example"> + &title.example; + <example> + <title>Defining a column</title> + <programlisting role="php"> + <![CDATA[ +<?php +require_once 'Structures/DataGrid.php'; + +$dg =& new Structures_DataGrid(); +$column = new Structures_DataGrid_Column('Title', 'title', 'title', array('align' => 'center'), 'N/A', null); +$dg->addColumn($column); +?> + ]]> + </programlisting> + </example> + </refsect1> + + </refentry> <!-- Keep this comment at the end of the file