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#ifndef __com_sun_star_form_XGridFieldDataSupplier_idl__ 20#define __com_sun_star_form_XGridFieldDataSupplier_idl__ 21 22#include <com/sun/star/uno/XInterface.idl> 23 24#include <com/sun/star/reflection/XIdlClass.idl> 25 26 27 28 module com { module sun { module star { module form { 29 30 31/** provides access to the data of a GridControl 32 33 <p>You can retrieve the data type information and the data in a row.</p> 34 35 <p>This interface allows to retrieve data even for rows which are not current, which is quite useful, 36 as normally, you can't affect the current row in a grid control without moving the cursor of the underlying 37 com::sun::star::form::component::DataForm.</p> 38 39 @see XGrid 40 @see com::sun::star::form::control::GridControl 41 @see com::sun::star::form::component::GridControl 42 43 @deprecated 44 */ 45published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface 46{ 47 /** checks whether or not the content of the grid's columns can be retrieved in the requested format. 48 49 <p>Not every cell content can be retrieved in every representation. For example, in a text column, 50 you usually won't be able to retrieve the content as double.<br/> 51 To check if the type you need is supported by the columns, use this method.</p> 52 53 @return 54 A sequence of boolean flags. Each flag corresponds to the respective column, and `TRUE` indicates 55 that the column content can be retrieved in the requested format, `FALSE` denies this. 56 57 @see XGridColumnFactory 58 @see DataAwareControlModel 59 @see XGridFieldDataSupplier::queryFieldData 60 */ 61 sequence<boolean> queryFieldDataType( [in] type xType ); 62 63 /** retrieves the actual column data for the given row 64 65 <p>If a column does not support the requested type, `NULL` is returned at the respective 66 position.</p> 67 68 @see XGridFieldDataSupplier::queryFieldDataType 69 */ 70 sequence<any> queryFieldData( [in] long nRow, 71 [in] type xType ); 72}; 73 74 75}; }; }; }; 76 77#endif 78 79/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ 80