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
24#ifndef __com_sun_star_container_XContainerApproveListener_idl
25#define __com_sun_star_container_XContainerApproveListener_idl
26
27#ifndef __com_sun_star_container_ContainerEvent_idl__
28#include <com/sun/star/container/ContainerEvent.idl>
29#endif
30
31#ifndef __com_sun_star_lang_WrappedTargetException_idl__
32#include <com/sun/star/lang/WrappedTargetException.idl>
33#endif
34
35#ifndef __com_sun_star_util_XVeto_idl__
36#include <com/sun/star/util/XVeto.idl>
37#endif
38
39//=============================================================================
40
41module com { module sun { module star { module container {
42
43//=============================================================================
44
45/** is notified to approve changes which happen to the content of a generic container
46
47    @see XContainerApproveBroadcaster
48 */
49interface XContainerApproveListener
50{
51    /** is called for the listener to approve an insertion into the container
52
53        @return
54            an instance implementing the <type scope="com::sun::star::util">XVeto</type> interface,
55            if the insertion is vetoed, <NULL/> otherwise.
56     */
57    com::sun::star::util::XVeto approveInsertElement( [in] ContainerEvent Event )
58      raises ( com::sun::star::lang::WrappedTargetException );
59
60    /** is called for the listener to approve a replacement inside the container
61
62        @return
63            an instance implementing the <type scope="com::sun::star::util">XVeto</type> interface,
64            if the replacement is vetoed, <NULL/> otherwise.
65     */
66    com::sun::star::util::XVeto approveReplaceElement( [in] ContainerEvent Event )
67      raises ( com::sun::star::lang::WrappedTargetException );
68
69    /** is called for the listener to approve a removal of an element from the container
70
71        @return
72            an instance implementing the <type scope="com::sun::star::util">XVeto</type> interface,
73            if the removal is vetoed, <NULL/> otherwise.
74     */
75    com::sun::star::util::XVeto approveRemoveElement( [in] ContainerEvent Event )
76      raises ( com::sun::star::lang::WrappedTargetException );
77};
78
79//=============================================================================
80
81}; }; }; };
82
83//=============================================================================
84
85#endif
86