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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_embed_XEmbeddedClient_idl__
  28 #define __com_sun_star_embed_XEmbeddedClient_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_embed_WrongStateException_idl__
  35 #include <com/sun/star/embed/WrongStateException.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_embed_XComponentSupplier_idl__
  39 #include <com/sun/star/embed/XComponentSupplier.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_embed_ObjectSaveVetoException_idl__
  43 #include <com/sun/star/embed/ObjectSaveVetoException.idl>
  44 #endif
  45
  46
  47
  48 //============================================================================
  49
  50  module com {  module sun {  module star {  module embed {
  51
  52 //============================================================================
  53 /** represents common functionality for embedded clients.
  54  */
  55 published interface XEmbeddedClient: XComponentSupplier
  56 {
  57     //------------------------------------------------------------------------
  58     /** asks client to let the object store itself.
  59
  60         @throws com::sun::star::uno::ObjectSaveVetoException
  61             in case container whants to avoid saving of object
  62
  63         @throws com::sun::star::uno::Exception
  64             in case of problems during saving
  65      */
  66     void saveObject()
  67         raises( ::com::sun::star::embed::ObjectSaveVetoException,
  68                 ::com::sun::star::uno::Exception );
  69
  70     //------------------------------------------------------------------------
  71     /** An object can use this method to notify the client when the object
  72         outplace window becomes visible or invisible.
  73
  74         @param bVisible
  75             visibility state of the window
  76
  77         @throws com::sun::star::embed::WrongStateException
  78             the object is in wrong state
  79      */
  80     void visibilityChanged( [in] boolean bVisible )
  81         raises( ::com::sun::star::embed::WrongStateException );
  82
  83 };
  84
  85 //============================================================================
  86
  87 }; }; }; };
  88
  89 #endif
  90