xref: /aoo42x/main/offapi/com/sun/star/embed/DocumentCloser.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_embed_DocumentCloser_idl__
#define __com_sun_star_embed_DocumentCloser_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_frame_XFrame_idl__
#include <com/sun/star/frame/XFrame.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_frame_DoubleInitializationException_idl__
#include <com/sun/star/frame/DoubleInitializationException.idl>
#endif

//=============================================================================
module com {  module sun {  module star {  module embed {

//-----------------------------------------------------------------------------
/** The main task of this service is to close an office document frame embedded
	in an application running in another process correctly.

	<p>
	The usual usage of this service is to create it, initialize with document
	frame, and to dispose the service. While disposing the service will do all
	the required actions to let the frame be closed using
	<type scope="com::sun::star::util">XCloseable</type>::close( true ). Thus
	in case there is a code that prevents closing of the frame the code
	avtomatically becomes the owner of the frame.
	</p>

	<p>
	In addition the code will disconnect the VCL window the frame is based on
	from the container system window.
	</p>
*/
published service DocumentCloser : com::sun::star::lang::XComponent
{
    /** is used to initialize the object on it's creation.

		@param xFrame
				the frame of the document that should be closed.

	 */
	DocumentCloserCtor1( [in] com::sun::star::frame::XFrame xFrame )
		raises( ::com::sun::star::lang::IllegalArgumentException,
				::com::sun::star::frame::DoubleInitializationException,
				::com::sun::star::uno::Exception );

};

//=============================================================================

}; }; }; };

#endif