summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/grid/UnoControlGrid.idl
blob: 5141e8a52cce2d8044f1a7386cccd92fa49c1f4d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_UnoControlGrid_idl__
#define __com_sun_star_awt_UnoControlGrid_idl__

#ifndef __com_sun_star_awt_UnoControl_idl__
#include <com/sun/star/awt/UnoControl.idl>
#endif

#ifndef __com_sun_star_awt_grid_XGridControl_idl__
#include <com/sun/star/awt/grid/XGridControl.idl>
#endif

//=============================================================================

 module com {  module sun {  module star {  module awt {  module grid {

//=============================================================================

//=============================================================================

/** A control that displays a set of tabular data.

    <p>
    <h4>The Column Model</h4>
    <p>The horizontal structure of the grid is defined by the <type>XGridColumnModel</type> implemented in <type>DefaultGridColumnModel</type>
    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.
    </p>
    <p>
    <h4>The Data Model</h4>
    <p> All row data are stored in the <type>XGridDataModel</type>.
    Use the <type>DefaultGridDataModel</type> to add  <member>XGridDataModel::addRow()</member> or remove <member>XGridDataModel::removeRow()</member> rows.
    </p>

    <p>The column and data model must be set at the <member>UnoControlGridModel::ColumnModel</member> and <member>UnoControlGridModel::GridDataModel</member> properties.</p>

    <h4>Selection</h4>
    <p>If you are interested in knowing when the selection changes implement a
    <type>XGridSelectionListener</type> and add the instance with the method
    <member>XGridSelection::addSelectionListener()</member>.
    You than will be notified for any selection change.

    The <type>XGridSelection</type> interface provides a bunch of methods to set and get selection for the grid control.
    </p>
    @since OOo 3.3
 */
service UnoControlGrid
{
    service com::sun::star::awt::UnoControl;

    interface com::sun::star::awt::grid::XGridControl;
};

//=============================================================================

}; }; }; };};

#endif