offapi/com/sun/star/form/XGridPeer.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 #ifndef __com_sun_star_form_XGridPeer_idl__
  20 #define __com_sun_star_form_XGridPeer_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/container/XIndexContainer.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module form {
  29
  30
  31 /** represents the window peer of a GridControl and allows you to set
  32     and retrieve the model data.
  33
  34     <p>Usually, the columns used are the columns as supplied by the grid control model.</p>
  35
  36     <p>You should use this interface only if you know exactly what you are doing. Tampering
  37     with the columns of a grid control which is part of a complex form can really hurt ....</p>
  38
  39     @deprecated
  40     @see com::sun::star::awt::XWindowPeer
  41     @see com::sun::star::form::component::GridControl
  42  */
  43 published interface XGridPeer: com::sun::star::uno::XInterface
  44 {
  45
  46     /** retrieves the currently used column definitions of the peer.
  47      */
  48     com::sun::star::container::XIndexContainer getColumns();
  49
  50
  51     /** sets the column definition for the peer.
  52      */
  53     void setColumns( [in] com::sun::star::container::XIndexContainer aColumns );
  54
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */