udkapi/com/sun/star/container/XContainer.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_container_XContainer_idl__
  20 #define __com_sun_star_container_XContainer_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/container/XContainerListener.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module container {
  29
  30
  31 /** supports quick access to the information if a container currently
  32     contains elements.
  33
  34     <p>The XContainer interface is provided for containers
  35     which need to broadcast changes within the container; that means
  36     the actions of adding or removing elements are broadcast to the
  37     listeners.  </p>
  38
  39     <p>This can be useful for UI to enable/disable some functions
  40     without actually accessing the data.  </p>
  41
  42     @see XContent
  43     @see XIndexAccess
  44     @see XNameAccess
  45     @see XEnumerationAccess
  46  */
  47 published interface XContainer: com::sun::star::uno::XInterface
  48 {
  49
  50     /** adds the specified listener to receive events when
  51         elements are inserted or removed.
  52
  53        <p>It is suggested to allow multiple registration of the same listener,
  54         thus for each time a listener is added, it has to be removed.
  55
  56         @see XContainerListener
  57      */
  58     void addContainerListener( [in] com::sun::star::container::XContainerListener xListener );
  59
  60
  61     /** removes the specified listener so it does not receive
  62         any events from this container.
  63
  64        <p>It is suggested to allow multiple registration of the same listener,
  65         thus for each time a listener is added, it has to be removed.
  66
  67         @see XContainerListener
  68      */
  69     void removeContainerListener( [in] com::sun::star::container::XContainerListener xListener );
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */