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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_uno_XAdapter_idl__
  20 #define __com_sun_star_uno_XAdapter_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/uno/XReference.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module uno {
  29
  30
  31 /** This is the server-side interface to a weak adapter.
  32
  33     <p>The implementation of XAdapter must know
  34     but not hold the adapted object, because it must not
  35     affect the lifetime of the adapted object.
  36
  37     </p>@see XWeak
  38         for description of concepts.
  39  */
  40 published interface XAdapter: com::sun::star::uno::XInterface
  41 {
  42     /** queries the adapted object if it is alive.
  43      */
  44     com::sun::star::uno::XInterface queryAdapted();
  45
  46     /** adds a reference to the adapter.
  47
  48
  49
  50         <p>All added references are called when the adapted object dies.
  51
  52         </p>
  53      */
  54     void addReference( [in] com::sun::star::uno::XReference xRef );
  55
  56     /** removes a reference from the adapter.
  57      */
  58     void removeReference( [in] com::sun::star::uno::XReference xRef );
  59
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */