offapi/com/sun/star/embed/DocumentCloser.idl

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