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