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_XUnloadingPreference_idl__ 28#define __com_sun_star_uno_XUnloadingPreference_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module uno { 37 38//============================================================================= 39/** Components can implement <code>XUnloadingPreference</code> in order to indicate 40 how they should be treated when their hosting library is to be unloaded. 41 42 When someone calls <code>rtl_unloadUnusedModules</code> then the unloading 43 listeners are notified by calling previously registered callback 44 functions. A listener is an entity that employs, registers, and 45 unregisters the callback functions on its behalf. Upon notification 46 (the callback function is being called) 47 a listener may release references to UNO components. Thus, the 48 loaded libraries can be unloaded, if no one else keeps any 49 objects from the library alive. <br> 50 Before a listener releases references, it should ask for this interface. 51 If the interface is not implemented, then the listener may release the 52 object; otherwise, it calls <code>releaseOnNotification</code>. If the function 53 returns false then the listener should keep the reference, otherwise 54 it may release it. 55*/ 56published interface XUnloadingPreference: com::sun::star::uno::XInterface 57{ 58 /** 59 The return value determines if the object wants to stay 60 alive in case of an unloading procedure. 61 @return 62 <FALSE/>do not release references to this object,otherwise 63 <TRUE/> 64 */ 65 boolean releaseOnNotification(); 66}; 67//============================================================================= 68 69}; }; }; }; 70 71#endif 72