offapi/com/sun/star/form/control/GridControl.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 module com {  module sun {  module star {  module form {
  22
  23 published interface XGridControl;
  24
  25 module control {
  26
  27
  28 /** describes a table-like control for displaying data.
  29
  30     <p>The model of the control has to support the com::sun::star::form::component::GridControl
  31     service.</p>
  32
  33     @see com::sun::star::awt::UnoControl
  34     @see com::sun::star::awt::UnoControlModel
  35 */
  36 published service GridControl
  37 {
  38     service com::sun::star::awt::UnoControl;
  39
  40     /** allows committing the content of the active cell of the control.
  41     */
  42     interface com::sun::star::form::XBoundComponent;
  43
  44     /** allows access to the active cell within the grid.
  45
  46         <p>Only the column position can be modified using this interface, as the row position within
  47         a table control bound to a data source is given implicitly (by the cursor position of the data source).</p>
  48     */
  49     interface com::sun::star::form::XGrid;
  50
  51     [optional] interface com::sun::star::form::XGridControl;
  52
  53     /** used to broadcast modifications made by the user (within the active cell)
  54     */
  55     interface com::sun::star::util::XModifyBroadcaster;
  56
  57     /** allows access to the field data of the grid's current row in different formats
  58     */
  59     [optional] interface com::sun::star::form::XGridFieldDataSupplier;
  60
  61     /** allows access to objects wrapping a single column
  62     */
  63     interface com::sun::star::container::XIndexAccess;
  64
  65     /** allows creation of an enumeration for the column objects
  66     */
  67     interface com::sun::star::container::XEnumerationAccess;
  68
  69     /** is used to switch the operating modes of the control.
  70
  71         <p>Besides the normal operation mode (which is used to display the database form's data) the control may
  72         for instance support a filter mode.</p>
  73     */
  74     [optional] interface com::sun::star::util::XModeSelector;
  75
  76     /** used to control the selection of rows in the grid control.
  77
  78         <p>The selection used with the methods com::sun::star::view::XSelectionSupplier::getSelection()
  79         and com::sun::star::view::XSelectionSupplier::select() is a sequence of Any's.<br/>
  80         Here the elements of the Sequence are the bookmarks (in the com::sun::star::sdb::RowSet)
  81         of the (to-be-) selected rows.</p>
  82     */
  83     [optional] interface com::sun::star::view::XSelectionSupplier;
  84
  85     /** allows external components to register dispatchers for some common form actions.
  86
  87         <p>A grid control can contain own UI elements for traveling within the database form it belongs to (This
  88         concept seems to make sense, as a grid control - in opposite to other data aware controls - displays
  89         not only one record at a time, but a larger number of records of the database form.)<br/>
  90         With the help of this interface, external components which wish to handle such travelings themselves can
  91         register interceptors for the actions in question.</p>
  92
  93         <p>Usual URLs to use include
  94             <dl>
  95                 <dt>.uno:FormSlots/moveToFirst</dt><dd> move the cursor to the first record</dd>
  96                 <dt>.uno:FormSlots/moveToPrev</dt><dd> move the cursor to the previous record</dd>
  97                 <dt>.uno:FormSlots/moveToNext</dt><dd> move the cursor to the next record</dd>
  98                 <dt>.uno:FormSlots/moveToLast</dt><dd> move the cursor to the last record</dd>
  99                 <dt>.uno:FormSlots/moveToNew</dt><dd> move the cursor to the (one and only) <em>new</em> record</dd>
 100                 <dt>.uno:FormSlots/undoRecord</dt><dd> undo the changes done so far in the current record</dd>
 101             </dl>
 102         </p>
 103
 104         <p>A concrete implementation of this service may offer more or less URLs, but if it offers some of the URLs
 105         above, it must stick to the meanings defined above.</p>
 106     */
 107     [optional] interface com::sun::star::frame::XDispatchProviderInterception;
 108 };
 109
 110
 111 }; }; }; }; };
 112
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */