1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_embed_DocumentCloser_idl__
29#define __com_sun_star_embed_DocumentCloser_idl__
30
31#ifndef __com_sun_star_lang_XComponent_idl__
32#include <com/sun/star/lang/XComponent.idl>
33#endif
34#ifndef __com_sun_star_uno_XInterface_idl__
35#include <com/sun/star/uno/XInterface.idl>
36#endif
37#ifndef __com_sun_star_frame_XFrame_idl__
38#include <com/sun/star/frame/XFrame.idl>
39#endif
40#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
41#include <com/sun/star/lang/IllegalArgumentException.idl>
42#endif
43#ifndef __com_sun_star_frame_DoubleInitializationException_idl__
44#include <com/sun/star/frame/DoubleInitializationException.idl>
45#endif
46
47//=============================================================================
48module com {  module sun {  module star {  module embed {
49
50//-----------------------------------------------------------------------------
51/** The main task of this service is to close an office document frame embedded
52	in an application running in another process correctly.
53
54	<p>
55	The usual usage of this service is to create it, initialize with document
56	frame, and to dispose the service. While disposing the service will do all
57	the required actions to let the frame be closed using
58	<type scope="com::sun::star::util">XCloseable</type>::close( true ). Thus
59	in case there is a code that prevents closing of the frame the code
60	avtomatically becomes the owner of the frame.
61	</p>
62
63	<p>
64	In addition the code will disconnect the VCL window the frame is based on
65	from the container system window.
66	</p>
67*/
68published service DocumentCloser : com::sun::star::lang::XComponent
69{
70    /** is used to initialize the object on it's creation.
71
72		@param xFrame
73				the frame of the document that should be closed.
74
75	 */
76	DocumentCloserCtor1( [in] com::sun::star::frame::XFrame xFrame )
77		raises( ::com::sun::star::lang::IllegalArgumentException,
78				::com::sun::star::frame::DoubleInitializationException,
79				::com::sun::star::uno::Exception );
80
81};
82
83//=============================================================================
84
85}; }; }; };
86
87#endif
88
89