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