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

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