offapi/com/sun/star/form/XGridPeer.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: XGridPeer.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_XGridPeer_idl__
  31 #define __com_sun_star_form_XGridPeer_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XIndexContainer_idl__
  38 #include <com/sun/star/container/XIndexContainer.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module form {
  45
  46 //=============================================================================
  47
  48 /** represents the window peer of a GridControl and allows you to set
  49     and retrieve the model data.
  50
  51     <p>Usually, the columns used are the columns as supplied by the grid control model.</p>
  52
  53     <p>You should use this interface only if you know exactly what you are doing. Tampering
  54     with the columns of a grid control which is part of a complex form can really hurt ....</p>
  55
  56     @deprecated
  57     @see com::sun::star::awt::XWindowPeer
  58     @see com::sun::star::form::component::GridControl
  59  */
  60 published interface XGridPeer: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** retrieves the currently used column definitions of the peer.
  65      */
  66     com::sun::star::container::XIndexContainer getColumns();
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** sets the column definition for the peer.
  71      */
  72     [oneway] void setColumns( [in] com::sun::star::container::XIndexContainer aColumns );
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 /*=============================================================================
  81
  82 =============================================================================*/
  83 #endif