summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/grid/XGridRowSelection.idl
blob: 15350deb1be7ce569299ccb950602f3a324a8935 (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
108
/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_awt_grid_XGridSelection_idl__
#define __com_sun_star_awt_grid_XGridSelection_idl__

#include <com/sun/star/awt/grid/XGridSelectionListener.idl>
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>

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

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

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

/** This interfaces provides access to the selection of row for <type>UnoControlGrid</type>.

    @since OpenOffice 3.4
 */
published interface XGridRowSelection
{
    /** Selects all rows.
    */
    void selectAllRows();

    /** selects a given row

        @param RowIndex
            denotes the index of the row to select

        @raises ::com::sun::star::lang::IndexOutOfBoundsException
            if <code>RowIndex</code> does not denote a valid row index
    */
    void selectRow( [in] long RowIndex )
        raises ( ::com::sun::star::lang::IndexOutOfBoundsException );

    /** Deselects all selected rows.
    */
    void deselectAllRows();

    /** removes the selection for a given row

        @param RowIndex
            denotes the index of the row to deselect
    */
    void deselectRow( [in] long RowIndex )
        raises ( ::com::sun::star::lang::IndexOutOfBoundsException );

    /** Returns the indices of all selected rows.
        @returns
            a sequence of indices.
    */
    sequence< long > getSelectedRows();

    /** Returns whether rows are selected.
        @returns
            <true/> if and only if at least one row is selected.
    */
    boolean hasSelectedRows();

    /** Returns whether a specific row is selected.

        @param RowIndex
            the index of a row. If the value does not denote a valid row index, i.e. is smaller than <code>0</code>
            or greater than the number of rows, this is silently ignored, and <false/> is returned.

        @returns
            <true/> if and only if there is a row with the given index, and it is selected currently.
    */
    boolean isRowSelected( [in] long RowIndex );

    /** Adds a listener for the <type>GridSelectionEvent</type> posted after the grid changes.
        @param listener
            the listener to add.
    */
    void addSelectionListener( [in] XGridSelectionListener  listener);

    /** Removes a listener previously added with <method>addSelectionListener()</method>.
        @param listener
            the listener to remove.
    */
    void removeSelectionListener( [in] XGridSelectionListener listener);
};

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

}; }; }; }; };

#endif