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_form_XResetListener_idl__ 24#define __com_sun_star_form_XResetListener_idl__ 25 26#ifndef __com_sun_star_lang_XEventListener_idl__ 27#include <com/sun/star/lang/XEventListener.idl> 28#endif 29 30#ifndef __com_sun_star_lang_EventObject_idl__ 31#include <com/sun/star/lang/EventObject.idl> 32#endif 33 34 35//============================================================================= 36 37 module com { module sun { module star { module form { 38 39//============================================================================= 40 41/** is the interface for receiving notificaions about reset events. 42 43 <p>The listener is called if a component implementing the 44 <type>XReset</type> interface performs a reset.</br> 45 Order of events: 46 <ul><li>a reset is triggered on a component</li> 47 <li>the component calls <member>XReset::approveReset</member> on all its listeners</li> 48 <li>if all listeners approve the reset operation, the data is reset</li> 49 <li>the component calls <member>XReset::resetted</member> on all its listeners</li> 50 </ul> 51 </p> 52 53 @see XReset 54 */ 55published interface XResetListener: com::sun::star::lang::XEventListener 56{ 57 //------------------------------------------------------------------------- 58 59 /** is invoked before a component is reset. 60 61 @param rEvent 62 the event happend. 63 64 @returns 65 <TRUE/> when reset was approved, <FALSE/> when the reset operation should be cancelled. 66 */ 67 boolean approveReset( [in] com::sun::star::lang::EventObject rEvent ); 68 69 //------------------------------------------------------------------------- 70 71 /** is invoked when a component has been reset. 72 73 @param rEvent 74 the event happend. 75 */ 76 [oneway] void resetted( [in] com::sun::star::lang::EventObject rEvent ); 77 78}; 79 80//============================================================================= 81 82}; }; }; }; 83 84/*============================================================================= 85 86=============================================================================*/ 87#endif 88