1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_view_XSelectionSupplier_idl__
24#define __com_sun_star_view_XSelectionSupplier_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34#ifndef __com_sun_star_view_XSelectionChangeListener_idl__
35#include <com/sun/star/view/XSelectionChangeListener.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module view {
42
43//=============================================================================
44
45/** makes it possible to access and change the selection in a view.
46
47	@see OfficeDocumentView
48 */
49published interface XSelectionSupplier: com::sun::star::uno::XInterface
50{
51	//-------------------------------------------------------------------------
52	/** selects the object represented by <var>xSelection</var> if it is
53		known and selectable in this object.
54	 */
55	boolean select( [in] any xSelection )
56			raises( com::sun::star::lang::IllegalArgumentException );
57
58	//-------------------------------------------------------------------------
59	/** @returns
60				the current selection.
61
62		<p>The selection is either specified by an object which is contained
63		in the component to which the view belongs, or it is an interface of a
64		collection which contains such objects.
65	 */
66	any getSelection();
67
68	//-------------------------------------------------------------------------
69	/** registers an event listener, which is called when the selection changes.
70	 */
71	void addSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
72
73	//-------------------------------------------------------------------------
74	/** unregisters an event listener which was registered with
75		<method>XSelectionSupplier::addSelectionChangeListener</method>.
76	 */
77	void removeSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
78
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86