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_frame_XTerminateListener_idl__ 24#define __com_sun_star_frame_XTerminateListener_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#ifndef __com_sun_star_frame_TerminationVetoException_idl__ 35#include <com/sun/star/frame/TerminationVetoException.idl> 36#endif 37 38 39//============================================================================= 40 41 module com { module sun { module star { module frame { 42 43//============================================================================= 44/** has to be provided if an object wants to receive an event 45 when the master environment (e.g., desktop) is terminated. 46 47 @see XDesktop::terminate() 48 @see XDesktop::addTerminateListener() 49 @see XDesktop::removeTerminateListener() 50 */ 51published interface XTerminateListener: com::sun::star::lang::XEventListener 52{ 53 //------------------------------------------------------------------------- 54 /** is called when the master environment (e.g., desktop) is about to terminate. 55 56 <p> 57 Termination can be intercepted by throwing <type>TerminationVetoException</type>. 58 Interceptor will be the new owner of desktop and should call <member>XDesktop::terminate()</member> 59 after finishing his own operations. 60 </p> 61 62 @param Event 63 describe the source of the event (e.g., the desktop) 64 65 @throws TerminationVetoException 66 listener can disagree with this query by throwing this veto exception 67 */ 68 void queryTermination( [in] com::sun::star::lang::EventObject Event ) 69 raises( TerminationVetoException ); 70 71 //------------------------------------------------------------------------- 72 /** is called when the master environment is finally terminated. 73 Not veto will be accepted then. 74 75 @param Event 76 describe the source of the event (e.g., the desktop) 77 */ 78 void notifyTermination( [in] com::sun::star::lang::EventObject Event ); 79}; 80 81//============================================================================= 82 83}; }; }; }; 84 85#endif 86