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
24#ifndef __com_sun_star_embed_DocumentCloser_idl__
25#define __com_sun_star_embed_DocumentCloser_idl__
26
27#ifndef __com_sun_star_lang_XComponent_idl__
28#include <com/sun/star/lang/XComponent.idl>
29#endif
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33#ifndef __com_sun_star_frame_XFrame_idl__
34#include <com/sun/star/frame/XFrame.idl>
35#endif
36#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
37#include <com/sun/star/lang/IllegalArgumentException.idl>
38#endif
39#ifndef __com_sun_star_frame_DoubleInitializationException_idl__
40#include <com/sun/star/frame/DoubleInitializationException.idl>
41#endif
42
43//=============================================================================
44module com {  module sun {  module star {  module embed {
45
46//-----------------------------------------------------------------------------
47/** The main task of this service is to close an office document frame embedded
48	in an application running in another process correctly.
49
50	<p>
51	The usual usage of this service is to create it, initialize with document
52	frame, and to dispose the service. While disposing the service will do all
53	the required actions to let the frame be closed using
54	<type scope="com::sun::star::util">XCloseable</type>::close( true ). Thus
55	in case there is a code that prevents closing of the frame the code
56	avtomatically becomes the owner of the frame.
57	</p>
58
59	<p>
60	In addition the code will disconnect the VCL window the frame is based on
61	from the container system window.
62	</p>
63*/
64published service DocumentCloser : com::sun::star::lang::XComponent
65{
66    /** is used to initialize the object on it's creation.
67
68		@param xFrame
69				the frame of the document that should be closed.
70
71	 */
72	DocumentCloserCtor1( [in] com::sun::star::frame::XFrame xFrame )
73		raises( ::com::sun::star::lang::IllegalArgumentException,
74				::com::sun::star::frame::DoubleInitializationException,
75				::com::sun::star::uno::Exception );
76
77};
78
79//=============================================================================
80
81}; }; }; };
82
83#endif
84
85