blob: f5358aa7d129a9c67b03b42daadc13d9d5c786c9 (
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*************************************************************************
*
* 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_view_XMultiSelectionSupplier_idl__
#define __com_sun_star_view_XMultiSelectionSupplier_idl__
#include <com/sun/star/view/XSelectionSupplier.idl>
#include <com/sun/star/container/XEnumeration.idl>
//=============================================================================
module com { module sun { module star { module view {
//=============================================================================
/** makes it possible to append and remove objects from a selection.
<p>The method <method>XSelectionSupplier::setSelection</method> for an
instance that also supports <type>XMultiSelectionSupplier</method> should
be implemented that it also takes either a selectable object or a sequence
of selectable objects.</p>
<p>Adding an object more than once to a selection should not toggle the
selection for that object but only select it once</p>
*/
published interface XMultiSelectionSupplier: XSelectionSupplier
{
//-------------------------------------------------------------------------
/** adds the object or the objects represented by <var>Selection</var> to the selection
of this <type>XMultiSelectionSupplier</type>.
@param Selection
either an Object that is selectable or a sequence of objects that are selectable.
@returns
<TRUE/>/, if <var>Selection</var> was added to the current selection.
<FALSE/>, if <var>Selection</var> or parts of <var>Selection</var> could not be
added to the current selection. For example, if the selection already contains
objects that are forbidden to be selected together with <var>Selection</var>
@throws com::sun::star::lang::IllegalArgumentException
If <var>Selection</var> is not a selectable object for this <type>XMultiSelectionSupplier</type>.
<p>Adding an object to the selection that is already part of the selection should not raise this exception</p>
*/
boolean addSelection( [in] any Selection )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** remove the object or objects represented by <var>Selection</var> from the
selection of this <type>XMultiSelectionSupplier</type>.
@param Selection
either an Object that is selectable or a sequence of objects that are selectable.
@returns
<TRUE/>/, if <var>Selection</var> was added to the current selection.
<FALSE/>, if <var>Selection</var> or parts of <var>Selection</var> could not be
added to the current selection. For example, if the selection already contains
objects that are forbidden to be selected together with <var>Selection</var>.
@throws com::sun::star::lang::IllegalArgumentException
If <var>Selection</var> is not a selectable object for this <type>XMultiSelectionSupplier</type>.
<p>Removing an object from the selection that is not part of the selection should not raise this exception</p>
*/
void removeSelection( [in] any Selection )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** clears the selection of this <type>XMultiSelectionSupplier</type>.
*/
void clearSelection();
//-------------------------------------------------------------------------
/** returns the number of selected objects of this <type>XMultiSelectionSupplier</type>.
*/
long getSelectionCount();
//-------------------------------------------------------------------------
/** @returns
a new object to enumerate the selection of this <type>XMultiSelectionSupplier</type>.
It returns NULL if there are no objects in the selection.
*/
com::sun::star::container::XEnumeration createSelectionEnumeration();
/** @returns
a new object to enumerate the selection of this <type>XMultiSelectionSupplier</type>
in reverse order. If the order of the selected objects
It returns NULL if there are no objects in the selection.
*/
com::sun::star::container::XEnumeration createReverseSelectionEnumeration();
};
//=============================================================================
}; }; }; };
#endif
|
