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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com {  module sun {  module star {  module embed {
  21
  22 /** The main task of this service is to close an office document frame embedded
  23     in an application running in another process correctly.
  24
  25     <p>
  26     The usual usage of this service is to create it, initialize with document
  27     frame, and to dispose the service. While disposing the service will do all
  28     the required actions to let the frame be closed using
  29     com::sun::star::util::XCloseable::close( true ). Thus
  30     in case there is a code that prevents closing of the frame the code
  31     automatically becomes the owner of the frame.
  32     </p>
  33
  34     <p>
  35     In addition the code will disconnect the VCL window the frame is based on
  36     from the container system window.
  37     </p>
  38 */
  39 published service DocumentCloser : com::sun::star::lang::XComponent
  40 {
  41     /** is used to initialize the object on it's creation.
  42
  43         @param xFrame
  44                 the frame of the document that should be closed.
  45
  46      */
  47     DocumentCloserCtor1( [in] com::sun::star::frame::XFrame xFrame )
  48         raises( ::com::sun::star::lang::IllegalArgumentException,
  49                 ::com::sun::star::frame::DoubleInitializationException,
  50                 ::com::sun::star::uno::Exception );
  51
  52 };
  53
  54
  55 }; }; }; };
  56
  57 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */