udkapi/com/sun/star/uno/XUnloadingPreference.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XUnloadingPreference.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_uno_XUnloadingPreference_idl__
  31 #define __com_sun_star_uno_XUnloadingPreference_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module uno {
  40
  41 //=============================================================================
  42 /** Components can implement <code>XUnloadingPreference</code> in order to indicate
  43     how they should be treated when their hosting library is to be unloaded.
  44
  45    When someone calls <code>rtl_unloadUnusedModules</code> then the unloading
  46     listeners are notified by calling previously registered callback
  47     functions. A listener is an entity that employs, registers, and
  48     unregisters the callback functions on its behalf. Upon notification
  49     (the callback function is being called)
  50     a listener may release references to UNO components. Thus, the
  51     loaded libraries can be unloaded, if no one else keeps any
  52     objects from the library alive. <br>
  53     Before a listener releases references, it should ask for this interface.
  54     If the interface is not implemented, then the listener may release the
  55     object; otherwise, it calls <code>releaseOnNotification</code>. If the function
  56     returns false then the listener should keep the reference, otherwise
  57     it may release it.
  58 */
  59 published interface XUnloadingPreference: com::sun::star::uno::XInterface
  60 {
  61     /**
  62         The return value determines if the object wants to stay
  63         alive in case of an unloading procedure.
  64         @return
  65         <FALSE/>do not release references to this object,otherwise
  66         <TRUE/>
  67     */
  68     boolean releaseOnNotification();
  69 };
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 #endif