xref: /aoo41x/main/udkapi/com/sun/star/uno/XAdapter.idl (revision cdf0e10c)
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_uno_XAdapter_idl__
28#define __com_sun_star_uno_XAdapter_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_uno_XReference_idl__
35#include <com/sun/star/uno/XReference.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module uno {
42
43//=============================================================================
44
45/** This is the server-side interface to a weak adapter.
46
47	<p>The implementation of <type>XAdapter</type> must know
48	but not hold the adapted object, because it must not
49	affect the lifetime of the adapted object.
50
51	</p>@see XWeak
52		for description of concepts.
53 */
54published interface XAdapter: com::sun::star::uno::XInterface
55{
56	//-------------------------------------------------------------------------
57
58	// DocMerge from xml: method com::sun::star::uno::XAdapter::queryAdapted
59	/** queries the adapted object if it is alive.
60	 */
61	com::sun::star::uno::XInterface queryAdapted();
62
63	//-------------------------------------------------------------------------
64
65	// DocMerge from xml: method com::sun::star::uno::XAdapter::addReference
66	/** adds a reference to the adapter.
67
68
69
70		<p>All added references are called when the adapted object dies.
71
72		</p>
73	 */
74	void addReference( [in] com::sun::star::uno::XReference xRef );
75
76	//-------------------------------------------------------------------------
77
78	// DocMerge from xml: method com::sun::star::uno::XAdapter::removeReference
79	/** removes a reference from the adapter.
80	 */
81	void removeReference( [in] com::sun::star::uno::XReference xRef );
82
83};
84
85//=============================================================================
86
87}; }; }; };
88
89/*=============================================================================
90
91=============================================================================*/
92#endif
93