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