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