offapi/com/sun/star/awt/grid/XGridControl.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_grid_XGridControl_idl__
  29 #define __com_sun_star_awt_grid_XGridControl_idl__
  30
  31 #include <com/sun/star/awt/grid/XGridSelection.idl>
  32
  33 //=============================================================================
  34
  35 module com {  module sun {  module star {  module awt { module grid {
  36
  37 //=============================================================================
  38
  39 /** An interface to a control that displays a tabular data.
  40
  41     @see UnoControlGrid
  42
  43     @since OOo 3.3
  44  */
  45 interface XGridControl : XGridSelection
  46 {
  47     /** retrieves the column which a given point belongs to
  48
  49         @param X
  50             the ordinate of the point, in pixel coordinates.
  51         @param Y
  52             the abscissa of the point, in pixel coordinates.
  53         @return
  54             the index of the column which the point lies in, or -1 if no column is under the given point.
  55     */
  56     long getColumnAtPoint( [in] long X, [in] long Y );
  57
  58     /** retrieves the row which a given point belongs to
  59
  60         @param X
  61             the ordinate of the point, in pixel coordinates.
  62         @param Y
  63             the abscissa of the point, in pixel coordinates.
  64         @return
  65             the index of the row which the point lies in, or -1 if no row is under the given point.
  66     */
  67     long getRowAtPoint( [in] long X, [in] long Y );
  68
  69     /** returns the column index of the currently active cell
  70
  71         <p>If the grid control's does not contain any cells (which happens if the grid column model does not contain any
  72         columns, or if grid data model does not contain any rows), then <code>-1</code> is returned.</p>
  73     */
  74     long getCurrentColumn();
  75
  76     /** returns the row index of the currently active cell
  77
  78         <p>If the grid control's does not contain any cells (which happens if the grid column model does not contain any
  79         columns, or if grid data model does not contain any rows), then <code>-1</code> is returned.</p>
  80     */
  81     long getCurrentRow();
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */