xref: /AOO41X/main/udkapi/com/sun/star/container/XContainer.idl (revision 408a4873fc8bcc602c90ea4598886bb71abf0675)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_container_XContainer_idl__
24#define __com_sun_star_container_XContainer_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_container_XContainerListener_idl__
31#include <com/sun/star/container/XContainerListener.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module container {
38
39//=============================================================================
40
41/** supports quick access to the information if a container currently
42    contains elements.
43
44    <p>The <type>XContainer</type> interface is provided for containers
45    which need to broadcast changes within the container; that means
46    the actions of adding or removing elements are broadcast to the
47    listeners.  </p>
48
49    <p>This can be useful for UI to enable/disable some functions
50    without actually accessing the data.  </p>
51
52    @see XContent
53    @see XIndexAccess
54    @see XNameAcces
55    @see XEnumerationAccess
56 */
57published interface XContainer: com::sun::star::uno::XInterface
58{
59    //-------------------------------------------------------------------------
60
61    /** adds the specified listener to receive events when
62        elements are inserted or removed.
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    [oneway] void addContainerListener( [in] com::sun::star::container::XContainerListener xListener );
70
71    //-------------------------------------------------------------------------
72
73    /** removes the specified listener so it does not receive
74        any events from this container.
75
76       <p>It is suggested to allow multiple registration of the same listener,
77        thus for each time a listener is added, it has to be removed.
78
79        @see XContainerListener
80     */
81    [oneway] void removeContainerListener( [in] com::sun::star::container::XContainerListener xListener );
82
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90