offapi/com/sun/star/embed/XEmbeddedClient.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 #ifndef __com_sun_star_embed_XEmbeddedClient_idl__
  20 #define __com_sun_star_embed_XEmbeddedClient_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/embed/WrongStateException.idl>
  24 #include <com/sun/star/embed/XComponentSupplier.idl>
  25 #include <com/sun/star/embed/ObjectSaveVetoException.idl>
  26
  27
  28
  29
  30  module com {  module sun {  module star {  module embed {
  31
  32 /** represents common functionality for embedded clients.
  33  */
  34 published interface XEmbeddedClient: XComponentSupplier
  35 {
  36     /** asks client to let the object store itself.
  37
  38         @throws com::sun::star::uno::ObjectSaveVetoException
  39             in case container chants to avoid saving of object
  40
  41         @throws com::sun::star::uno::Exception
  42             in case of problems during saving
  43      */
  44     void saveObject()
  45         raises( ::com::sun::star::embed::ObjectSaveVetoException,
  46                 ::com::sun::star::uno::Exception );
  47
  48     /** An object can use this method to notify the client when the object
  49         outplace window becomes visible or invisible.
  50
  51         @param bVisible
  52             visibility state of the window
  53
  54         @throws com::sun::star::embed::WrongStateException
  55             the object is in wrong state
  56      */
  57     void visibilityChanged( [in] boolean bVisible )
  58         raises( ::com::sun::star::embed::WrongStateException );
  59
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */