udkapi/com/sun/star/lang/XConnectionPointContainer.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
  20
  21 module com {  module sun {  module star {  module lang {
  22
  23  published interface XConnectionPoint;
  24
  25 /** makes it possible to locate a specific connection point
  26     for a specified UIK and manages a sequence of connections points.
  27
  28     <p>An implementation of this interface <strong>must</strong>
  29     support the com::sun::star::uno::XWeak interface.
  30     Look at the language binding for a superclass or something else.  </p>
  31
  32     @see XConnectionPoint
  33     @see com::sun::star::uno::XWeak
  34  */
  35 published interface XConnectionPointContainer: com::sun::star::uno::XInterface
  36 {
  37     /** @returns
  38             a sequence of all outgoing types; specifies which are supported
  39             by this connectable object.
  40      */
  41     sequence<type> getConnectionPointTypes();
  42
  43     /** @returns
  44             an XConnectionPoint interface of a
  45             connection point for a specified type if that type
  46             describes a supported outgoing interface. It is
  47             NULL on failure of the call.
  48
  49         @param aType
  50             specifies the connection point's type.
  51      */
  52     XConnectionPoint queryConnectionPoint( [in] type aType );
  53
  54     /** creates a connection between this object and a
  55         client's sink, where the sink implements the outgoing
  56         interface specified with ID.
  57
  58         <p>The interface is advised under the connection point you
  59         get with <code>queryConnectionPoint( id )</code>.  </p>
  60
  61         <p>Use this method instead of the advise method at the
  62         connection point, only if you know that the broadcaster supports
  63         the outgoing interface, or if it does not matter that the
  64         outgoing interface is not supported.  </p>
  65
  66         @see XConnectionPoint::advise
  67      */
  68     void advise( [in] type aType,
  69              [in] com::sun::star::uno::XInterface xListener );
  70
  71     /** terminates a notification previously set up with
  72         advise at the container or at the suitable connection point.
  73
  74         @see XConnectionPoint::unadvise
  75      */
  76     void unadvise( [in] type aType,
  77              [in] com::sun::star::uno::XInterface xListener );
  78
  79 };
  80
  81
  82 }; }; }; };
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */