summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/awt/grid/UnoControlGrid.idl
blob: caa51125646c61c0f3215e23a5a99f29767b9f15 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_awt_grid_UnoControlGrid_idl__
#define __com_sun_star_awt_grid_UnoControlGrid_idl__

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

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

#include <com/sun/star/awt/grid/XGridRowSelection.idl>


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



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

    <h4>The Column Model</h4>

    <p>The horizontal structure of the grid is defined by the XGridColumnModel implemented in DefaultGridColumnModel
    The XGridColumn implemented in GridColumn describes the properties and behavior of a single column. Use the XGridColumnModel::addColumn() to add a column to the column model.
    </p>

    <h4>The Data Model</h4>
    <p> All row data are stored in the XGridDataModel.
    Use the DefaultGridDataModel to add  XGridDataModel::addRow() or remove XGridDataModel::removeRow() rows.
    </p>

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

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

    @since OOo 3.3
 */
service UnoControlGrid
{
    service com::sun::star::awt::UnoControl;

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

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


}; }; }; };};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */