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