offapi/com/sun/star/form/XGrid.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_XGrid_idl__
  20 #define __com_sun_star_form_XGrid_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26  module com {  module sun {  module star {  module form {
  27
  28
  29 /** provides the possibility of setting and retrieving the position
  30     of the current cell in a grid control.
  31
  32     <p>Note that a grid control does not allow free control over the current row:
  33     In such a control, every line represents a row of data of the underlying
  34     <type scope="com::sun::star::form::component">DataForm</type>. Thus, the <em>current
  35     row</em> of the grid control always equals the current row of the
  36     <type scope="com::sun::star::form::component">DataForm</type>, and can be affected only
  37     by changing the latter.<br/>
  38     The current column of a grid control, whoever, can be freely controlled.</p>
  39
  40     @see com::sun::star::form::component::GridControl
  41     @see com::sun::star::form::control::GridControl
  42     @deprecated
  43  */
  44 published interface XGrid: com::sun::star::uno::XInterface
  45 {
  46
  47     /** retrieves the current column position.
  48      */
  49     short getCurrentColumnPosition();
  50
  51
  52     /** sets the current column position.
  53      */
  54     void setCurrentColumnPosition( [in] short nPos );
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */