<html> <head> <title>Interface XGridDataModel</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="XGridDataModel-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"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></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 XGridDataModel</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XGridDataModel</strong> ┣ ::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">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>implements life time control for the component </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XCloneable.html">XCloneable</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows cloning the complete column model </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>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> <dt><b>Since </b></dt> <dd>OOo 3.3</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="#getCellData">getCellData</a></td> <td class="imsum_right">retrieves the data for a given cell </td> </tr> <tr> <td class="imsum_left"><a href="#getCellToolTip">getCellToolTip</a></td> <td class="imsum_right">retrieves the tool tip to be displayed when the mouse hovers over a given cell </td> </tr> <tr> <td class="imsum_left"><a href="#getRowHeading">getRowHeading</a></td> <td class="imsum_right">retrieves the heading of a given row </td> </tr> </table> <a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Attributes' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#RowCount">RowCount</a></td> <td class="imsum_right">denotes the number of rows for which the model can provide data </td> </tr> <tr> <td class="imsum_left"><a href="#ColumnCount">ColumnCount</a></td> <td class="imsum_right">denotes the number of columns for which the model can provide data </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="getCellData" class="membertitle">getCellData</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">any</td> </tr> <tr> <td valign="top"><b>getCellData</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Column,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> Row )</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>retrieves the data for a given cell </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the column or row index do not denote a valid cell position. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getCellToolTip" class="membertitle">getCellToolTip</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">any</td> </tr> <tr> <td valign="top"><b>getCellToolTip</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> Column,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> Row )</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>retrieves the tool tip to be displayed when the mouse hovers over a given cell </dd> <dd><p>At the moment, only string tool tips are supported.</p> <p>If <b>void</b> is returned here, the cell's content will be displayed as tip, but only if it does not fit into the cell.</p> </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IndexOutOfBoundsException if the column or row index do not denote a valid cell position. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRowHeading" class="membertitle">getRowHeading</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">any</td> </tr> <tr> <td valign="top"><b>getRowHeading</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>retrieves the heading of a given row </dd> <dd><p>A grid control will usually paint a row's title in the header column of the respective row.</p> <p>At the moment, only strings are supported as row headings.</p> </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> </table> <a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Attributes' Details</td> </tr> <tr> <td class="imdetail"><a name="RowCount" class="membertitle">RowCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>RowCount</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the number of rows for which the model can provide data </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ColumnCount" class="membertitle">ColumnCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>ColumnCount</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes the number of columns for which the model can provide data </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>
