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_embed_XStateChangeListener_idl__
24#define __com_sun_star_embed_XStateChangeListener_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_embed_WrongStateException_idl__
35#include <com/sun/star/embed/WrongStateException.idl>
36#endif
37
38//============================================================================
39
40module com {  module sun {  module star {  module embed {
41
42//============================================================================
43
44/** makes it possible to receive events when an embedded object changes it's
45	state.
46 */
47published interface XStateChangeListener: com::sun::star::lang::XEventListener
48{
49	//------------------------------------------------------------------------
50	/** is called just before the object changes state.
51
52		<p>
53		Actually the listener can try to complain about state changing, but
54		it is up to object to decide whether the state change can be
55		prevented. Anyway the possibility to complain must be used very
56		carefully.
57		</p>
58
59		@param aEvent
60			specifies the object that is going to change own state
61
62		@param nOldState
63			specifies the old state of the object
64
65		@param nNewState
66			specifies the new state of the object
67
68		@throws ::com::sun::star::embed::WrongStateException
69			the state change is unexpected by listener
70	 */
71	void changingState( [in] com::sun::star::lang::EventObject aEvent,
72						[in] long nOldState,
73						[in] long nNewState )
74		raises( ::com::sun::star::embed::WrongStateException );
75
76	//------------------------------------------------------------------------
77	/** is called after the object has changed state.
78
79		@param aEvent
80			specifies the object that has changed own state
81
82		@param nOldState
83			specifies the old state of the object
84
85		@param nNewState
86			specifies the new state of the object
87	 */
88	void stateChanged( [in] com::sun::star::lang::EventObject aEvent,
89						[in] long nOldState,
90						[in] long nNewState );
91};
92
93//============================================================================
94
95}; }; }; };
96
97#endif
98
99