blob: 7dd4903ef218f24c7c965fb8cf8056752a7e7303 (
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
109
110
111
112
|
/*************************************************************************
*
* 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_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.org 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 indicies of all selected rows.
@returns
a sequence of indicies.
*/
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
|
