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_awt_UnoControlGrid_idl__
24#define __com_sun_star_awt_UnoControlGrid_idl__
25
26#ifndef __com_sun_star_awt_UnoControl_idl__
27#include <com/sun/star/awt/UnoControl.idl>
28#endif
29
30#ifndef __com_sun_star_awt_grid_XGridControl_idl__
31#include <com/sun/star/awt/grid/XGridControl.idl>
32#endif
33
34#ifndef __com_sun_star_awt_grid_XGridRowSelection_idl__
35#include <com/sun/star/awt/grid/XGridRowSelection.idl>
36#endif
37
38//=============================================================================
39
40 module com {  module sun {  module star {  module awt {  module grid {
41
42//=============================================================================
43
44//=============================================================================
45
46/** A control that displays a set of tabular data.
47
48	<h4>The Column Model</h4>
49
50    <p>The horizontal structure of the grid is defined by the <type>XGridColumnModel</type> implemented in <type>DefaultGridColumnModel</type>
51	The <type>XGridColumn</type> implemented in <typeGridColumn</type> describes the properties and behavior of a single column. Use the <member>XGridColumnModel::addColumn()</member> to add a column to the column model.
52	</p>
53
54    <h4>The Data Model</h4>
55	<p> All row data are stored in the <type>XGridDataModel</type>.
56	Use the <type>DefaultGridDataModel</type> to add  <member>XGridDataModel::addRow()</member> or remove <member>XGridDataModel::removeRow()</member> rows.
57	</p>
58
59	<p>The column and data model must be set at the <member>UnoControlGridModel::ColumnModel</member> and <member>UnoControlGridModel::GridDataModel</member> properties.</p>
60
61	<h4>Selection</h4>
62	<p>If you are interested in knowing when the selection changes implement a
63	<type>XGridSelectionListener</type> and add the instance with the method
64	<member>XGridRowSelection::addSelectionListener()</member>.
65	You than will be notified for any selection change.</p>
66
67	<p>The <type>XGridSelection</type> interface provides a bunch of methods to set and get selection for the grid control.</p>
68	@since OpenOffice 3.3
69 */
70service UnoControlGrid
71{
72	service com::sun::star::awt::UnoControl;
73
74    interface ::com::sun::star::awt::grid::XGridControl;
75
76    interface ::com::sun::star::awt::grid::XGridRowSelection;
77};
78
79//=============================================================================
80
81}; }; }; };};
82
83#endif
84