1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * $Revision: 1.8 $ 4*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 5*cdf0e10cSrcweir * 6*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 7*cdf0e10cSrcweir * 8*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 9*cdf0e10cSrcweir * 10*cdf0e10cSrcweir * This file is part of OpenOffice.org. 11*cdf0e10cSrcweir * 12*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 13*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 14*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 15*cdf0e10cSrcweir * 16*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 17*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 18*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 20*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 21*cdf0e10cSrcweir * 22*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 23*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 24*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 25*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 26*cdf0e10cSrcweir * 27*cdf0e10cSrcweir ************************************************************************/ 28*cdf0e10cSrcweir#ifndef __com_sun_star_awt_grid_XGridDataModel_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_awt_grid_XGridDataModel_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir 32*cdf0e10cSrcweir#include <com/sun/star/lang/XComponent.idl> 33*cdf0e10cSrcweir#include <com/sun/star/util/XCloneable.idl> 34*cdf0e10cSrcweir#include <com/sun/star/awt/grid/XGridDataListener.idl> 35*cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir//============================================================================= 38*cdf0e10cSrcweir 39*cdf0e10cSrcweirmodule com { module sun { module star { module awt { module grid { 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir//============================================================================= 42*cdf0e10cSrcweir/** An instance of this interface is used by the <type>UnoControlGrid</type> to 43*cdf0e10cSrcweir retrieve the content data that is displayed in the actual control. 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir If you do not need your own model implementation, you can also use the <type>DefaultGridDataModel</type>. 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir @since OOo 3.3 48*cdf0e10cSrcweir*/ 49*cdf0e10cSrcweirpublished interface XGridDataModel 50*cdf0e10cSrcweir{ 51*cdf0e10cSrcweir /** implements life time control for the component 52*cdf0e10cSrcweir */ 53*cdf0e10cSrcweir interface ::com::sun::star::lang::XComponent; 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir /** allows cloning the complete data model 56*cdf0e10cSrcweir */ 57*cdf0e10cSrcweir interface ::com::sun::star::util::XCloneable; 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir /** denotes the number of rows for which the model can provide data 60*cdf0e10cSrcweir */ 61*cdf0e10cSrcweir [attribute, readonly] long RowCount; 62*cdf0e10cSrcweir 63*cdf0e10cSrcweir /** denotes the number of columns for which the model can provide data 64*cdf0e10cSrcweir */ 65*cdf0e10cSrcweir [attribute, readonly] long ColumnCount; 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir /** retrieves the data for a given cell 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir @throws ::com::sun::star::lang::IndexOutOfBoundsException 70*cdf0e10cSrcweir if the column or row index do not denote a valid cell position. 71*cdf0e10cSrcweir */ 72*cdf0e10cSrcweir any getCellData( [in] long Column, [in] long RowIndex ) 73*cdf0e10cSrcweir raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir /** retrieves the tool tip to be displayed when the mouse hovers over a given cell 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir <p>At the moment, only string tool tips are supported.</p> 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir <p>If <VOID/> is returned here, the cell's content will be displayed as tip, but only if it does 80*cdf0e10cSrcweir not fit into the cell.</p> 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir @throws ::com::sun::star::lang::IndexOutOfBoundsException 83*cdf0e10cSrcweir if the column or row index do not denote a valid cell position. 84*cdf0e10cSrcweir */ 85*cdf0e10cSrcweir any getCellToolTip( [in] long Column, [in] long RowIndex ) 86*cdf0e10cSrcweir raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir /** retrieves the heading of a given row 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir <p>A grid control will usually paint a row's title in the header column of the respective row.</p> 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir <p>At the moment, only strings are supported as row headings.</p> 93*cdf0e10cSrcweir 94*cdf0e10cSrcweir @throws ::com::sun::star::lang::IndexOutOfBoundsException 95*cdf0e10cSrcweir if the given index does not denote a valid row. 96*cdf0e10cSrcweir */ 97*cdf0e10cSrcweir any 98*cdf0e10cSrcweir getRowHeading( [in] long RowIndex ) 99*cdf0e10cSrcweir raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir /** retrieves the data for a complete row 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir <p>This method is provided for performance and convenience reasons, it delivers the same result 104*cdf0e10cSrcweir as subsequent calls to <member>getCellData</member> would.</p> 105*cdf0e10cSrcweir 106*cdf0e10cSrcweir @param Row 107*cdf0e10cSrcweir the index of the row whose data should is to be retrieved. 108*cdf0e10cSrcweir @raises ::com::sun::star::lang::IndexOutOfBoundsException 109*cdf0e10cSrcweir of the given row index does not denote a valid row. 110*cdf0e10cSrcweir */ 111*cdf0e10cSrcweir sequence< any > 112*cdf0e10cSrcweir getRowData( [in] long RowIndex ) 113*cdf0e10cSrcweir raises ( ::com::sun::star::lang::IndexOutOfBoundsException ); 114*cdf0e10cSrcweir}; 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir//============================================================================= 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir}; }; }; };}; 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir#endif 121