<html> <head> <title>Interface XMutableGridDataModel</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XMutableGridDataModel-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">awt</a> :: <a href="module-ix.html" class="namechain">grid</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XMutableGridDataModel</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XMutableGridDataModel</strong> ┗ <a href="XGridDataModel.html">XGridDataModel</a> ┣ ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a> ┗ ::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XCloneable.html">XCloneable</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XGridDataModel.html">XGridDataModel</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>An instance of this interface is used by the <a href="UnoControlGrid.html">UnoControlGrid</a> to retrieve the content data that is displayed in the actual control. If you do not need your own model implementation, you can also use the <a href="DefaultGridDataModel.html">DefaultGridDataModel</a>. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>allows to modify the data represented by a <a href="XGridDataModel.html">XGridDataModel</a> </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#addRow">addRow</a></td> <td class="imsum_right">adds a row to the model. </td> </tr> <tr> <td class="imsum_left"><a href="#addRows">addRows</a></td> <td class="imsum_right">adds multiple rows of data to the model. </td> </tr> <tr> <td class="imsum_left"><a href="#removeRow">removeRow</a></td> <td class="imsum_right">removes a row of data from the model </td> </tr> <tr> <td class="imsum_left"><a href="#removeAllRows">removeAllRows</a></td> <td class="imsum_right">Removes all rows from the model. </td> </tr> <tr> <td class="imsum_left"><a href="#updateCellData">updateCellData</a></td> <td class="imsum_right">updates the content of the given cell </td> </tr> <tr> <td class="imsum_left"><a href="#updateRowData">updateRowData</a></td> <td class="imsum_right">updates the content of a given row. </td> </tr> <tr> <td class="imsum_left"><a href="#updateRowHeading">updateRowHeading</a></td> <td class="imsum_right">sets a new title for a given row. </td> </tr> <tr> <td class="imsum_left"><a href="#updateCellToolTip">updateCellToolTip</a></td> <td class="imsum_right">updates the tooltip to be displayed for a given cell </td> </tr> <tr> <td class="imsum_left"><a href="#updateRowToolTip">updateRowToolTip</a></td> <td class="imsum_right">updates the tooltip for all cells of a given row </td> </tr> <tr> <td class="imsum_left"><a href="#addGridDataListener">addGridDataListener</a></td> <td class="imsum_right">registers listener to be notified of data changes in the model </td> </tr> <tr> <td class="imsum_left"><a href="#removeGridDataListener">removeGridDataListener</a></td> <td class="imsum_right">revokes a listener which was previously registered via <a href="#addGridDataListener">addGridDataListener</a> </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="addRow" class="membertitle">addRow</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addRow</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Heading,</td> </tr> <tr> <td/><td valign="top">[in] sequence< any ></td> <td valign="bottom"> Data );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds a row to the model. </dd> <dt><b>Parameter Heading</b></dt> <dd>denotes the heading of the row. </dd> <dt><b>Parameter Data</b></dt> <dd>specifies the content of the row. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addRows" class="membertitle">addRows</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addRows</b>(</td> <td valign="top">[in] sequence< any ></td> <td valign="bottom"> Headings,</td> </tr> <tr> <td/><td valign="top">[in] sequence< sequence< any > ></td> <td valign="bottom"> Data )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds multiple rows of data to the model. </dd> <dt><b>Parameter Headings</b></dt> <dd>denotes the headings of the to-be-added rows. </dd> <dt><b>Parameter Data</b></dt> <dd>specifies the data of the rows to be added. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException if <code>Titles</code> and <code>Data</code> are of different length. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeRow" class="membertitle">removeRow</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeRow</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> RowIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes a row of data from the model </dd> <dt><b>Parameter RowIndex</b></dt> <dd>the index of the row that should be removed. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the given index is invalid </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeAllRows" class="membertitle">removeAllRows</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeAllRows</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Removes all rows from the model. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="updateCellData" class="membertitle">updateCellData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>updateCellData</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> ColumnIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> RowIndex,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> Value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>updates the content of the given cell </dd> <dt><b>Parameter ColumnIndex</b></dt> <dd>the column index of the to-be-updated cell </dd> <dt><b>Parameter RowIndex</b></dt> <dd>the row index of the to-be-updated cell </dd> <dt><b>Parameter Value</b></dt> <dd>the new value of the cell. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the row or column index is invalid </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="updateRowData" class="membertitle">updateRowData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>updateRowData</b>(</td> <td valign="top">[in] sequence< long ></td> <td valign="bottom"> ColumnIndexes,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> RowIndex,</td> </tr> <tr> <td/><td valign="top">[in] sequence< any ></td> <td valign="bottom"> Values )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>updates the content of a given row. </dd> <dd><p>The change in the data model will be notified to registered listeners via <a href="XGridDataListener.html">XGridDataListener</a>::<a href="XGridDataListener.html#dataChanged">dataChanged</a>. The <a href="GridDataEvent.html">GridDataEvent</a>::<a href="GridDataEvent.html#FirstColumn">FirstColumn</a> and <a href="GridDataEvent.html">GridDataEvent</a>::<a href="GridDataEvent.html#LastColumn">LastColumn</a> will denote the smallest respectively largest column index from <arg>ColumnIndexes</arg>.</p> </dd> <dt><b>Parameter ColumnIndexes</b></dt> <dd>contains the column indexes of the cells, which should be updated </dd> <dt><b>Parameter RowIndex</b></dt> <dd>contains the index of the row whose data is to be updated </dd> <dt><b>Parameter Values</b></dt> <dd>specifies the new values of the cells. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if one of the row indexes or the column index is invalid </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the lengths of the <code>ColumnIndexes</code> and <code>Values</code> sequences are not equal. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="updateRowHeading" class="membertitle">updateRowHeading</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>updateRowHeading</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> RowIndex,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> Heading )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets a new title for a given row. </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the given index does not denote a valid row. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="updateCellToolTip" class="membertitle">updateCellToolTip</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>updateCellToolTip</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> ColumnIndex,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> RowIndex,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> Value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>updates the tooltip to be displayed for a given cell </dd> <dt><b>See also</b></dt> <dd><a href="XGridDataModel.html">XGridDataModel</a>::<a href="XGridDataModel.html#getCellToolTip">getCellToolTip</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="updateRowToolTip" class="membertitle">updateRowToolTip</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>updateRowToolTip</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> RowIndex,</td> </tr> <tr> <td/><td valign="top">[in] any</td> <td valign="bottom"> Value )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>updates the tooltip for all cells of a given row </dd> <dd><p>Effectively this method is a shortcut for calling <a href="#updateCellToolTip">updateCellToolTip</a> multiple times in a row, for all cells of a given row.</p> </dd> <dt><b>See also</b></dt> <dd><a href="XGridDataModel.html">XGridDataModel</a>::<a href="XGridDataModel.html#getCellToolTip">getCellToolTip</a>, <a href="#updateCellToolTip">updateCellToolTip</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addGridDataListener" class="membertitle">addGridDataListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>addGridDataListener</b>(</td> <td valign="top">[in] <a href="XGridDataListener.html">XGridDataListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers listener to be notified of data changes in the model </dd> <dt><b>Parameter Listener</b></dt> <dd>specifies the listener to register </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeGridDataListener" class="membertitle">removeGridDataListener</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeGridDataListener</b>(</td> <td valign="top">[in] <a href="XGridDataListener.html">XGridDataListener</a></td> <td valign="bottom"> Listener );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>revokes a listener which was previously registered via <a href="#addGridDataListener">addGridDataListener</a> </dd> <dt><b>Parameter Listener</b></dt> <dd>specifies the listener to revoke. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
