1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XUnloadingPreference_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_uno_XUnloadingPreference_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module uno { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski/** Components can implement <code>XUnloadingPreference</code> in order to indicate 36*b1cdbd2cSJim Jagielski how they should be treated when their hosting library is to be unloaded. 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski When someone calls <code>rtl_unloadUnusedModules</code> then the unloading 39*b1cdbd2cSJim Jagielski listeners are notified by calling previously registered callback 40*b1cdbd2cSJim Jagielski functions. A listener is an entity that employs, registers, and 41*b1cdbd2cSJim Jagielski unregisters the callback functions on its behalf. Upon notification 42*b1cdbd2cSJim Jagielski (the callback function is being called) 43*b1cdbd2cSJim Jagielski a listener may release references to UNO components. Thus, the 44*b1cdbd2cSJim Jagielski loaded libraries can be unloaded, if no one else keeps any 45*b1cdbd2cSJim Jagielski objects from the library alive. <br> 46*b1cdbd2cSJim Jagielski Before a listener releases references, it should ask for this interface. 47*b1cdbd2cSJim Jagielski If the interface is not implemented, then the listener may release the 48*b1cdbd2cSJim Jagielski object; otherwise, it calls <code>releaseOnNotification</code>. If the function 49*b1cdbd2cSJim Jagielski returns false then the listener should keep the reference, otherwise 50*b1cdbd2cSJim Jagielski it may release it. 51*b1cdbd2cSJim Jagielski*/ 52*b1cdbd2cSJim Jagielskipublished interface XUnloadingPreference: com::sun::star::uno::XInterface 53*b1cdbd2cSJim Jagielski{ 54*b1cdbd2cSJim Jagielski /** 55*b1cdbd2cSJim Jagielski The return value determines if the object wants to stay 56*b1cdbd2cSJim Jagielski alive in case of an unloading procedure. 57*b1cdbd2cSJim Jagielski @return 58*b1cdbd2cSJim Jagielski <FALSE/>do not release references to this object,otherwise 59*b1cdbd2cSJim Jagielski <TRUE/> 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski boolean releaseOnNotification(); 62*b1cdbd2cSJim Jagielski}; 63*b1cdbd2cSJim Jagielski//============================================================================= 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski}; }; }; }; 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski#endif 68