<html> <head> <title>Service GridControl</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="GridControl-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="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub"><a href="#InterfacesSummary" class="navisub">Interfaces' Summary</a></td> <td class="navisub">Properties' Summary</td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub"><a href="#InterfacesDetails" class="navisub">Interfaces' Details</a></td> <td class="navisub">Properties' 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">form</a> :: <a href="module-ix.html" class="namechain">control</a> :: </p> </td> </tr> <tr> <td class="title">service GridControl</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>describes a table-like control for displaying data. </dd> <dd><p>The model of the control has to support the ::com::sun::star::form::<a href="../component/module-ix.html">component</a>::<a href="../component/GridControl.html">GridControl</a> service.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControl.html">UnoControl</a>, ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlModel.html">UnoControlModel</a></dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControl.html">UnoControl</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies an abstract control. </dd> </dl> </td> </tr> </table> <a name="InterfacesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XBoundComponent.html">XBoundComponent</a></td> <td class="imsum_right"><p>allows committing the content of the active cell of the control. </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGrid.html">XGrid</a></td> <td class="imsum_right"><p>allows access to the active cell within the grid. (<a href="#XGrid">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGridControl.html">XGridControl</a></td> <td class="imsum_right"/></tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XModifyBroadcaster.html">XModifyBroadcaster</a></td> <td class="imsum_right"><p>used to broadcast modifications made by the user (within the active cell) </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGridFieldDataSupplier.html">XGridFieldDataSupplier</a></td> <td class="imsum_right"><p>allows access to the field data of the grid's current row in different formats (<a href="#XGridFieldDataSupplier">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../container/module-ix.html">container</a>::<a href="../../container/XIndexAccess.html">XIndexAccess</a></td> <td class="imsum_right"><p>allows access to objects wrapping a single column </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../container/module-ix.html">container</a>::<a href="../../container/XEnumerationAccess.html">XEnumerationAccess</a></td> <td class="imsum_right"><p>allows creation of an enumeration for the column objects </p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XModeSelector.html">XModeSelector</a></td> <td class="imsum_right"><p>is used to switch the operating modes of the control. (<a href="#XModeSelector">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../view/module-ix.html">view</a>::<a href="../../view/XSelectionSupplier.html">XSelectionSupplier</a></td> <td class="imsum_right"><p>used to control the selection of rows in the grid control. (<a href="#XSelectionSupplier">details</a>)</p> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/XDispatchProviderInterception.html">XDispatchProviderInterception</a></td> <td class="imsum_right"><p>allows external components to register dispatchers for some common form actions. (<a href="#XDispatchProviderInterception">details</a>)</p> </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="UnoControl" class="membertitle">::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControl.html">UnoControl</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies an abstract control. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a name="InterfacesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="XBoundComponent" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XBoundComponent.html">XBoundComponent</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows committing the content of the active cell of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XGrid" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGrid.html">XGrid</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows access to the active cell within the grid. </dd> <dd><p>Only the column position can be modified using this interface, as the row position within a table control bound to a data source is given implicitly (by the cursor position of the data source).</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XGridControl" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGridControl.html">XGridControl</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XModifyBroadcaster" class="membertitle">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XModifyBroadcaster.html">XModifyBroadcaster</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>used to broadcast modifications made by the user (within the active cell) </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XGridFieldDataSupplier" class="membertitle">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XGridFieldDataSupplier.html">XGridFieldDataSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>allows access to the field data of the grid's current row in different formats </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XIndexAccess" class="membertitle">::com::sun::star::<a href="../../container/module-ix.html">container</a>::<a href="../../container/XIndexAccess.html">XIndexAccess</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows access to objects wrapping a single column </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XEnumerationAccess" class="membertitle">::com::sun::star::<a href="../../container/module-ix.html">container</a>::<a href="../../container/XEnumerationAccess.html">XEnumerationAccess</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows creation of an enumeration for the column objects </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XModeSelector" class="membertitle">::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XModeSelector.html">XModeSelector</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>is used to switch the operating modes of the control. </dd> <dd><p>Besides the normal operation mode (which is used to display the database form's data) the control may for instance support a filter mode.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XSelectionSupplier" class="membertitle">::com::sun::star::<a href="../../view/module-ix.html">view</a>::<a href="../../view/XSelectionSupplier.html">XSelectionSupplier</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>used to control the selection of rows in the grid control. </dd> <dd><p>The selection used with the methods <method scope="com::sun::star::view">XSelectionSupplier::getSelection</method> and <method scope="com::sun::star::view">XSelectionSupplier::select</method> is a sequence of Any's.<br/> Here the elements of the Sequence are the bookmarks (in the ::com::sun::star::<a href="../../sdb/module-ix.html">sdb</a>::<a href="../../sdb/RowSet.html">RowSet</a>) of the (to-be-) selected rows.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr/> <tr> <td class="imdetail"><a name="XDispatchProviderInterception" class="membertitle">::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/XDispatchProviderInterception.html">XDispatchProviderInterception</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>allows external components to register dispatchers for some common form actions. </dd> <dd><p>A grid control can contain own UI elements for traveling within the database form it belongs to (This concept seems to make sense, as a grid control - in opposite to other data aware controls - displays not only one record at a time, but a larger number of records of the database form.)<br/> With the help of this interface, external components which wish to handle such travelings themselves can register interceptors for the actions in question.</p> <p>Usual URLs to use include <dl> <dt>.uno:FormSlots/moveToFirst</dt><dd> move the cursor to the first record</dd> <dt>.uno:FormSlots/moveToPrev</dt><dd> move the cursor to the previous record</dd> <dt>.uno:FormSlots/moveToNext</dt><dd> move the cursor to the next record</dd> <dt>.uno:FormSlots/moveToLast</dt><dd> move the cursor to the last record</dd> <dt>.uno:FormSlots/moveToNew</dt><dd> move the cursor to the (one and only) <em>new</em> record</dd> <dt>.uno:FormSlots/undoRecord</dt><dd> undo the changes done so far in the current record</dd> </dl> </p> <p>A concrete implementation of this service may offer more or less URLs, but if it offers some of the URLs above, it must stick to the meanings defined above.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <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>
