offapi/com/sun/star/awt/grid/XGridControl.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 module com {  module sun {  module star {  module awt { module grid {
  22
  23
  24 /** An interface to a control that displays a tabular data.
  25
  26     @see UnoControlGrid
  27
  28     @since OOo 3.3
  29  */
  30 published interface XGridControl
  31 {
  32     /** retrieves the column which a given point belongs to
  33
  34         @param X
  35             the ordinate of the point, in pixel coordinates.
  36         @param Y
  37             the abscissa of the point, in pixel coordinates.
  38         @return
  39             the index of the column which the point lies in, or -1 if no column is under the given point.
  40     */
  41     long getColumnAtPoint( [in] long X, [in] long Y );
  42
  43     /** retrieves the row which a given point belongs to
  44
  45         @param X
  46             the ordinate of the point, in pixel coordinates.
  47         @param Y
  48             the abscissa of the point, in pixel coordinates.
  49         @return
  50             the index of the row which the point lies in, or -1 if no row is under the given point.
  51     */
  52     long getRowAtPoint( [in] long X, [in] long Y );
  53
  54     /** returns the column index of the currently active cell
  55
  56         <p>If the grid control's does not contain any cells (which happens if the grid column model does not contain any
  57         columns, or if grid data model does not contain any rows), then <code>-1</code> is returned.</p>
  58     */
  59     long getCurrentColumn();
  60
  61     /** returns the row index of the currently active cell
  62
  63         <p>If the grid control's does not contain any cells (which happens if the grid column model does not contain any
  64         columns, or if grid data model does not contain any rows), then <code>-1</code> is returned.</p>
  65     */
  66     long getCurrentRow();
  67
  68     /** moves the cursor to the given cell
  69         @param ColumnIndex
  70             the column index of the cell to activate.
  71         @param RowIndex
  72             the row index of the cell to activate.
  73         @throws ::com::sun::star::lang::IndexOutOfBoundsException
  74             if either <code>ColumnIndex</code> or <code>RowIndex</code> are out of range.
  75         @throws ::com::sun::star::util::VetoException
  76             if moving the cursor to another cell is vetoed.
  77     */
  78     void    goToCell(
  79                 [in] long ColumnIndex,
  80                 [in] long RowIndex
  81             )
  82             raises  (   ::com::sun::star::lang::IndexOutOfBoundsException
  83                     ,   ::com::sun::star::util::VetoException
  84                     );
  85 };
  86
  87
  88 }; }; }; }; };
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */