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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_form_XGrid_idl__
  28 #define __com_sun_star_form_XGrid_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34
  35 //=============================================================================
  36
  37  module com {  module sun {  module star {  module form {
  38
  39 //=============================================================================
  40
  41 /** provides the possibility of setting and retrieving the position
  42     of the current cell in a grid control.
  43
  44     <p>Note that a grid control does not allow free control over the current row:
  45     In such a control, every line represents a row of data of the underlying
  46     <type scope="com::sun::star::form::component">DataForm</type>. Thus, the <em>current
  47     row</em> of the grid control always equals the current row of the
  48     <type scope="com::sun::star::form::component">DataForm</type>, and can be affected only
  49     by changing the latter.<br/>
  50     The current column of a grid control, whoever, can be freely controlled.</p>
  51
  52     @see com::sun::star::form::component::GridControl
  53     @see com::sun::star::form::control::GridControl
  54     @deprecated
  55  */
  56 published interface XGrid: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** retrieves the current column position.
  61      */
  62     short getCurrentColumnPosition();
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** sets the current column position.
  67      */
  68     [oneway] void setCurrentColumnPosition( [in] short nPos );
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 /*=============================================================================
  77
  78 =============================================================================*/
  79 #endif