xref: /AOO41X/main/udkapi/com/sun/star/uno/XReference.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
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_XReference_idl__
24#define __com_sun_star_uno_XReference_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module uno {
34
35//=============================================================================
36
37// DocMerge from xml: interface com::sun::star::uno::XReference
38/** must be implemented by anyone who holds the adapter on the client side.@see XWeak
39        for decription af concepts.
40 */
41published interface XReference: com::sun::star::uno::XInterface
42{
43    //-------------------------------------------------------------------------
44
45    // DocMerge from xml: method com::sun::star::uno::XReference::dispose
46    /** removes all references to the adapter.
47
48
49
50        <p> This method is called when the adapted object dies.
51        The implementation of the client-side's weak reference
52        must include removal of all references to the adapter.
53        Otherwise, the adapted object will be destroyed, but the
54        adapter will be alive.</p>
55     */
56    [oneway] void dispose();
57
58};
59
60//=============================================================================
61
62}; }; }; };
63
64/*=============================================================================
65
66=============================================================================*/
67#endif
68