xref: /trunk/main/offapi/com/sun/star/embed/XTransactionListener.idl (revision d125dbfc)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_embed_XTransactionListener_idl__
#define __com_sun_star_embed_XTransactionListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

#ifndef __com_sun_star_lang_EventObject_idl__
#include <com/sun/star/lang/EventObject.idl>
#endif

#ifndef __com_sun_star_uno_Exception_idl__
#include <com/sun/star/uno/Exception.idl>
#endif

//============================================================================

module com {  module sun {  module star {  module embed {

//============================================================================

/** makes it possible to receive events when a transacted object is committed
	or reverted.
 */
published interface XTransactionListener: com::sun::star::lang::XEventListener
{
	//------------------------------------------------------------------------
	/** is called just before the object is committed.
	 */
	void preCommit( [in] com::sun::star::lang::EventObject aEvent )
		raises( ::com::sun::star::uno::Exception );

	//------------------------------------------------------------------------
	/** is called after the object is committed.
	 */
	void commited( [in] com::sun::star::lang::EventObject aEvent );

	//------------------------------------------------------------------------
	/** is called just before the object is reverted.
	 */
	void preRevert( [in] com::sun::star::lang::EventObject aEvent )
		raises( ::com::sun::star::uno::Exception );

	//------------------------------------------------------------------------
	/** is called after the object is reverted.
	 */
	void reverted( [in] com::sun::star::lang::EventObject aEvent );
};

//============================================================================

}; }; }; };

#endif