udkapi/com/sun/star/uno/XAdapter.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: XAdapter.idl,v $
  10  * $Revision: 1.13 $
  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_XAdapter_idl__
  31 #define __com_sun_star_uno_XAdapter_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_uno_XReference_idl__
  38 #include <com/sun/star/uno/XReference.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module uno {
  45
  46 //=============================================================================
  47
  48 /** This is the server-side interface to a weak adapter.
  49
  50     <p>The implementation of <type>XAdapter</type> must know
  51     but not hold the adapted object, because it must not
  52     affect the lifetime of the adapted object.
  53
  54     </p>@see XWeak
  55         for description of concepts.
  56  */
  57 published interface XAdapter: com::sun::star::uno::XInterface
  58 {
  59     //-------------------------------------------------------------------------
  60
  61     // DocMerge from xml: method com::sun::star::uno::XAdapter::queryAdapted
  62     /** queries the adapted object if it is alive.
  63      */
  64     com::sun::star::uno::XInterface queryAdapted();
  65
  66     //-------------------------------------------------------------------------
  67
  68     // DocMerge from xml: method com::sun::star::uno::XAdapter::addReference
  69     /** adds a reference to the adapter.
  70
  71
  72
  73         <p>All added references are called when the adapted object dies.
  74
  75         </p>
  76      */
  77     void addReference( [in] com::sun::star::uno::XReference xRef );
  78
  79     //-------------------------------------------------------------------------
  80
  81     // DocMerge from xml: method com::sun::star::uno::XAdapter::removeReference
  82     /** removes a reference from the adapter.
  83      */
  84     void removeReference( [in] com::sun::star::uno::XReference xRef );
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 /*=============================================================================
  93
  94 =============================================================================*/
  95 #endif