udkapi/com/sun/star/container/XContainer.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_container_XContainer_idl__
  28 #define __com_sun_star_container_XContainer_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_container_XContainerListener_idl__
  35 #include <com/sun/star/container/XContainerListener.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module container {
  42
  43 //=============================================================================
  44
  45 /** supports quick access to the information if a container currently
  46     contains elements.
  47
  48     <p>The <type>XContainer</type> interface is provided for containers
  49     which need to broadcast changes within the container; that means
  50     the actions of adding or removing elements are broadcast to the
  51     listeners.  </p>
  52
  53     <p>This can be useful for UI to enable/disable some functions
  54     without actually accessing the data.  </p>
  55
  56     @see XContent
  57     @see XIndexAccess
  58     @see XNameAcces
  59     @see XEnumerationAccess
  60  */
  61 published interface XContainer: com::sun::star::uno::XInterface
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** adds the specified listener to receive events when
  66         elements are inserted or removed.
  67
  68        <p>It is suggested to allow multiple registration of the same listener,
  69         thus for each time a listener is added, it has to be removed.
  70
  71         @see XContainerListener
  72      */
  73     [oneway] void addContainerListener( [in] com::sun::star::container::XContainerListener xListener );
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** removes the specified listener so it does not receive
  78         any events from this container.
  79
  80        <p>It is suggested to allow multiple registration of the same listener,
  81         thus for each time a listener is added, it has to be removed.
  82
  83         @see XContainerListener
  84      */
  85     [oneway] void removeContainerListener( [in] com::sun::star::container::XContainerListener xListener );
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif