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