1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_view_XSelectionSupplier_idl__
28#define __com_sun_star_view_XSelectionSupplier_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38#ifndef __com_sun_star_view_XSelectionChangeListener_idl__
39#include <com/sun/star/view/XSelectionChangeListener.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module view {
46
47//=============================================================================
48
49/** makes it possible to access and change the selection in a view.
50
51	@see OfficeDocumentView
52 */
53published interface XSelectionSupplier: com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56	/** selects the object represented by <var>xSelection</var> if it is
57		known and selectable in this object.
58	 */
59	boolean select( [in] any xSelection )
60			raises( com::sun::star::lang::IllegalArgumentException );
61
62	//-------------------------------------------------------------------------
63	/** @returns
64				the current selection.
65
66		<p>The selection is either specified by an object which is contained
67		in the component to which the view belongs, or it is an interface of a
68		collection which contains such objects.
69	 */
70	any getSelection();
71
72	//-------------------------------------------------------------------------
73	/** registers an event listener, which is called when the selection changes.
74	 */
75	void addSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
76
77	//-------------------------------------------------------------------------
78	/** unregisters an event listener which was registered with
79		<method>XSelectionSupplier::addSelectionChangeListener</method>.
80	 */
81	void removeSelectionChangeListener( [in] com::sun::star::view::XSelectionChangeListener xListener );
82
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90