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

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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