summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/grid/XGridControl.idl
blob: f8413046839a755e03323781c7d9e0163502e3a2 (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*************************************************************************
 *
 * 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_grid_XGridControl_idl__
#define __com_sun_star_awt_grid_XGridControl_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#include <com/sun/star/util/VetoException.idl>

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

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

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

/** An interface to a control that displays a tabular data.

    @see UnoControlGrid

    @since OOo 3.3
 */
published interface XGridControl
{
    /** retrieves the column which a given point belongs to

        @param X
            the ordinate of the point, in pixel coordinates.
        @param Y
            the abscissa of the point, in pixel coordinates.
        @return
            the index of the column which the point lies in, or -1 if no column is under the given point.
    */
    long getColumnAtPoint( [in] long X, [in] long Y );

    /** retrieves the row which a given point belongs to

        @param X
            the ordinate of the point, in pixel coordinates.
        @param Y
            the abscissa of the point, in pixel coordinates.
        @return
            the index of the row which the point lies in, or -1 if no row is under the given point.
    */
    long getRowAtPoint( [in] long X, [in] long Y );

    /** returns the column index of the currently active cell

        <p>If the grid control's does not contain any cells (which happens if the grid column model does not contain any
        columns, or if grid data model does not contain any rows), then <code>-1</code> is returned.</p>
    */
    long getCurrentColumn();

    /** returns the row index of the currently active cell

        <p>If the grid control's does not contain any cells (which happens if the grid column model does not contain any
        columns, or if grid data model does not contain any rows), then <code>-1</code> is returned.</p>
    */
    long getCurrentRow();

    /** moves the cursor to the given cell
        @param ColumnIndex
            the column index of the cell to activate.
        @param RowIndex
            the row index of the cell to activate.
        @throws ::com::sun::star::lang::IndexOutOfBoundsException
            if either <code>ColumnIndex</code> or <code>RowIndex</code> are out of range.
        @throws ::com::sun::star::util::VetoException
            if moving the cursor to another cell is vetoed.
    */
    void    goToCell(
                [in] long ColumnIndex,
                [in] long RowIndex
            )
            raises  (   ::com::sun::star::lang::IndexOutOfBoundsException
                    ,   ::com::sun::star::util::VetoException
                    );
};

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

}; }; }; }; };

#endif