1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XWeak_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_uno_XWeak_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XAdapter_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/uno/XAdapter.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir//============================================================================= 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir module com { module sun { module star { module uno { 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir//============================================================================= 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir// DocMerge from xml: interface com::sun::star::uno::XWeak 46*cdf0e10cSrcweir/** the server-side interface to a weak object. 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir <p>This interface is proxy to the adapted object. 51*cdf0e10cSrcweir In order to make it possible to have weak references to objects, 52*cdf0e10cSrcweir the <type>XAdapter</type> interface must be implemented to provide 53*cdf0e10cSrcweir a weak adapter for the clients. 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir <h4>Concept of weak referencing:</h4> 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir </p> 58*cdf0e10cSrcweir <p>This module specifies the interfaces for implementing and using 59*cdf0e10cSrcweir weak references.</p> 60*cdf0e10cSrcweir <p> 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir </p> 63*cdf0e10cSrcweir <p>The sense of weak references is to hold a reference to an object 64*cdf0e10cSrcweir without affecting the lifetime of the object. That means that a weak 65*cdf0e10cSrcweir reference may become invalid, at any time, if the referenced object dies. 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir </p> 68*cdf0e10cSrcweir <p>The following interfaces describe one way to handle weak references 69*cdf0e10cSrcweir by providing a weak adapter. The weak object has to provide this 70*cdf0e10cSrcweir adapter if anyone wants to hold a weak reference. To separate their 71*cdf0e10cSrcweir lifetimes, the adapter and the original object must not share the same 72*cdf0e10cSrcweir reference counter. The weak reference is in fact only a hard reference 73*cdf0e10cSrcweir to the adapter, which knows - but does not hold - the original object. 74*cdf0e10cSrcweir That means that the implementation and synchronization of weak 75*cdf0e10cSrcweir referencing is the responsibility of the object. The following 76*cdf0e10cSrcweir interfaces are involved in the concept of weak referencing: 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir <dl> 79*cdf0e10cSrcweir <dt> 80*cdf0e10cSrcweir <type>XWeak</type> 81*cdf0e10cSrcweir </dt> 82*cdf0e10cSrcweir <dd>is the server-side interface of the referred object. This 83*cdf0e10cSrcweir referred object must support the <type>XAdapter</type> interface. 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir </dd> 86*cdf0e10cSrcweir <dt> 87*cdf0e10cSrcweir <type>XReference</type> 88*cdf0e10cSrcweir </dt> 89*cdf0e10cSrcweir <dd>is a client-side interface which must be implemented by 90*cdf0e10cSrcweir the holder of any weak reference. It is used for notification 91*cdf0e10cSrcweir when the adapted object dies. 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir </dd> 94*cdf0e10cSrcweir </dl> 95*cdf0e10cSrcweir </p> 96*cdf0e10cSrcweir */ 97*cdf0e10cSrcweirpublished interface XWeak: com::sun::star::uno::XInterface 98*cdf0e10cSrcweir{ 99*cdf0e10cSrcweir //------------------------------------------------------------------------- 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir // DocMerge from xml: method com::sun::star::uno::XWeak::queryAdapter 102*cdf0e10cSrcweir /** queries the weak adapter. 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir 105*cdf0e10cSrcweir 106*cdf0e10cSrcweir <p>It is important that the adapter must know, but not hold 107*cdf0e10cSrcweir the adapted object. If the adapted object dies, all references 108*cdf0e10cSrcweir to the adapter have to be notified to release the adapter. 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir </p> 111*cdf0e10cSrcweir */ 112*cdf0e10cSrcweir com::sun::star::uno::XAdapter queryAdapter(); 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir}; 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir//============================================================================= 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir}; }; }; }; 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir/*============================================================================= 121*cdf0e10cSrcweir 122*cdf0e10cSrcweir=============================================================================*/ 123*cdf0e10cSrcweir#endif 124