/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_container_XContainerApproveListener_idl
#define __com_sun_star_container_XContainerApproveListener_idl

#include <com/sun/star/container/ContainerEvent.idl>
#include <com/sun/star/lang/WrappedTargetException.idl>
#include <com/sun/star/util/XVeto.idl>


module com { module sun { module star { module container {


/** is notified to approve changes which happen to the content of a generic container

    @see XContainerApproveBroadcaster
 */
interface XContainerApproveListener
{
    /** is called for the listener to approve an insertion into the container

        @return
            an instance implementing the com::sun::star::util::XVeto interface,
            if the insertion is vetoed, `NULL` otherwise.
     */
    com::sun::star::util::XVeto approveInsertElement( [in] ContainerEvent Event )
      raises ( com::sun::star::lang::WrappedTargetException );

    /** is called for the listener to approve a replacement inside the container

        @return
            an instance implementing the com::sun::star::util::XVeto interface,
            if the replacement is vetoed, `NULL` otherwise.
     */
    com::sun::star::util::XVeto approveReplaceElement( [in] ContainerEvent Event )
      raises ( com::sun::star::lang::WrappedTargetException );

    /** is called for the listener to approve a removal of an element from the container

        @return
            an instance implementing the com::sun::star::util::XVeto interface,
            if the removal is vetoed, `NULL` otherwise.
     */
    com::sun::star::util::XVeto approveRemoveElement( [in] ContainerEvent Event )
      raises ( com::sun::star::lang::WrappedTargetException );
};


}; }; }; };


#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
