offapi/com/sun/star/form/XGridControl.idl

   1 /*************************************************************************
   2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3  *
   4  * Copyright 2000, 2010 Oracle and/or its affiliates.
   5  *
   6  * OpenOffice.org - a multi-platform office productivity suite
   7  *
   8  * This file is part of OpenOffice.org.
   9  *
  10  * OpenOffice.org is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Lesser General Public License version 3
  12  * only, as published by the Free Software Foundation.
  13  *
  14  * OpenOffice.org is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Lesser General Public License version 3 for more details
  18  * (a copy is included in the LICENSE file that accompanied this code).
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * version 3 along with OpenOffice.org.  If not, see
  22  * <http://www.openoffice.org/license.html>
  23  * for a copy of the LGPLv3 License.
  24  *
  25 ************************************************************************/
  26
  27 #ifndef __com_sun_star_form_XGridControl_idl__
  28 #define __com_sun_star_form_XGridControl_idl__
  29
  30 #include <com/sun/star/form/XGrid.idl>
  31 #include <com/sun/star/form/XGridControlListener.idl>
  32 #include <com/sun/star/form/XGridFieldDataSupplier.idl>
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module form {
  37
  38 //=============================================================================
  39
  40 /** specifies (some) functionality provided by a grid control (aka table control)
  41
  42     @since OOo 3.1
  43  */
  44 interface XGridControl
  45 {
  46     /** allows access to the current column position within the grid control
  47     */
  48     interface XGrid;
  49
  50     /** registers a listener which is to be notified about state changes in
  51         the grid control
  52     */
  53     void    addGridControlListener( [in] XGridControlListener _listener );
  54
  55     /** revokes a previously registered grid control listener
  56     */
  57     void    removeGridControlListener( [in] XGridControlListener _listener );
  58
  59     /// provides access to the data in the control, even in non-current rows
  60     interface XGridFieldDataSupplier;
  61 };
  62
  63 //=============================================================================
  64
  65 }; }; }; };
  66
  67 //=============================================================================
  68
  69 #endif