1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_embed_DocumentCloser_idl__ 25*b1cdbd2cSJim Jagielski#define __com_sun_star_embed_DocumentCloser_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_XComponent_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/XComponent.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_frame_XFrame_idl__ 34*b1cdbd2cSJim Jagielski#include <com/sun/star/frame/XFrame.idl> 35*b1cdbd2cSJim Jagielski#endif 36*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 37*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 38*b1cdbd2cSJim Jagielski#endif 39*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_frame_DoubleInitializationException_idl__ 40*b1cdbd2cSJim Jagielski#include <com/sun/star/frame/DoubleInitializationException.idl> 41*b1cdbd2cSJim Jagielski#endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module embed { 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski//----------------------------------------------------------------------------- 47*b1cdbd2cSJim Jagielski/** The main task of this service is to close an office document frame embedded 48*b1cdbd2cSJim Jagielski in an application running in another process correctly. 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski <p> 51*b1cdbd2cSJim Jagielski The usual usage of this service is to create it, initialize with document 52*b1cdbd2cSJim Jagielski frame, and to dispose the service. While disposing the service will do all 53*b1cdbd2cSJim Jagielski the required actions to let the frame be closed using 54*b1cdbd2cSJim Jagielski <type scope="com::sun::star::util">XCloseable</type>::close( true ). Thus 55*b1cdbd2cSJim Jagielski in case there is a code that prevents closing of the frame the code 56*b1cdbd2cSJim Jagielski avtomatically becomes the owner of the frame. 57*b1cdbd2cSJim Jagielski </p> 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski <p> 60*b1cdbd2cSJim Jagielski In addition the code will disconnect the VCL window the frame is based on 61*b1cdbd2cSJim Jagielski from the container system window. 62*b1cdbd2cSJim Jagielski </p> 63*b1cdbd2cSJim Jagielski*/ 64*b1cdbd2cSJim Jagielskipublished service DocumentCloser : com::sun::star::lang::XComponent 65*b1cdbd2cSJim Jagielski{ 66*b1cdbd2cSJim Jagielski /** is used to initialize the object on it's creation. 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @param xFrame 69*b1cdbd2cSJim Jagielski the frame of the document that should be closed. 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski DocumentCloserCtor1( [in] com::sun::star::frame::XFrame xFrame ) 73*b1cdbd2cSJim Jagielski raises( ::com::sun::star::lang::IllegalArgumentException, 74*b1cdbd2cSJim Jagielski ::com::sun::star::frame::DoubleInitializationException, 75*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Exception ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski}; 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski//============================================================================= 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski}; }; }; }; 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski#endif 84*b1cdbd2cSJim Jagielski 85