1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_form_XGridFieldDataSupplier_idl__
24#define __com_sun_star_form_XGridFieldDataSupplier_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_reflection_XIdlClass_idl__
31#include <com/sun/star/reflection/XIdlClass.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module form {
38
39//=============================================================================
40
41/** provides access to the data of a GridControl
42
43	<p>You can retrieve the data type information and the data in a row.</p>
44
45	<p>This interface allows to retrieve data even for rows which are not current, which is quite usefull,
46	as normally, you can't affect the current row in a grid control without moving the cursor of the underlying
47	<type scope="com::sun::star::form::component">DataForm</type>.</p>
48
49	@see XGrid
50	@see com::sun::star::form::control::GridControl
51	@see com::sun::star::form::component::GridControl
52
53	@deprecated
54 */
55published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface
56{
57	//-------------------------------------------------------------------------
58	/** checks whether or not the content of the grid's columns can be retrieved in the requested format.
59
60		<p>Not every cell content can be retrieved in every representation. For example, in a text column,
61		you usually won't be able to retrieve the content as double.<br/>
62		To check if the type you need is supported by the columns, use this method.</p>
63
64		@return
65			A sequence of boolean flags. Each flag corresponds to the respective column, and <TRUE/> indicates
66			that the column content can be retrieved in the requested format, <FALSE/> denies this.
67
68		@see XGridColumnFactory
69		@see DataAwareControlModel
70		@see XGridFieldDataSupplier::queryFieldData
71	*/
72	sequence<boolean> queryFieldDataType( [in] type xType );
73
74	//-------------------------------------------------------------------------
75	/** retrieves the actual column data for the given row
76
77		<p>If a column does not support the requested type, <NULL/> is returned at the respective
78		position.</p>
79
80		@see XGridFieldDataSupplier::queryFieldDataType
81	*/
82	sequence<any> queryFieldData( [in] long nRow,
83			 [in] type xType );
84};
85
86//=============================================================================
87
88}; }; }; };
89
90/*=============================================================================
91
92=============================================================================*/
93#endif
94