1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_form_XGridFieldDataSupplier_idl__ 28#define __com_sun_star_form_XGridFieldDataSupplier_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34#ifndef __com_sun_star_reflection_XIdlClass_idl__ 35#include <com/sun/star/reflection/XIdlClass.idl> 36#endif 37 38 39//============================================================================= 40 41 module com { module sun { module star { module form { 42 43//============================================================================= 44 45/** provides access to the data of a GridControl 46 47 <p>You can retrieve the data type information and the data in a row.</p> 48 49 <p>This interface allows to retrieve data even for rows which are not current, which is quite usefull, 50 as normally, you can't affect the current row in a grid control without moving the cursor of the underlying 51 <type scope="com::sun::star::form::component">DataForm</type>.</p> 52 53 @see XGrid 54 @see com::sun::star::form::control::GridControl 55 @see com::sun::star::form::component::GridControl 56 57 @deprecated 58 */ 59published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface 60{ 61 //------------------------------------------------------------------------- 62 /** checks whether or not the content of the grid's columns can be retrieved in the requested format. 63 64 <p>Not every cell content can be retrieved in every representation. For example, in a text column, 65 you usually won't be able to retrieve the content as double.<br/> 66 To check if the type you need is supported by the columns, use this method.</p> 67 68 @return 69 A sequence of boolean flags. Each flag corresponds to the respective column, and <TRUE/> indicates 70 that the column content can be retrieved in the requested format, <FALSE/> denies this. 71 72 @see XGridColumnFactory 73 @see DataAwareControlModel 74 @see XGridFieldDataSupplier::queryFieldData 75 */ 76 sequence<boolean> queryFieldDataType( [in] type xType ); 77 78 //------------------------------------------------------------------------- 79 /** retrieves the actual column data for the given row 80 81 <p>If a column does not support the requested type, <NULL/> is returned at the respective 82 position.</p> 83 84 @see XGridFieldDataSupplier::queryFieldDataType 85 */ 86 sequence<any> queryFieldData( [in] long nRow, 87 [in] type xType ); 88}; 89 90//============================================================================= 91 92}; }; }; }; 93 94/*============================================================================= 95 96=============================================================================*/ 97#endif 98