xref: /AOO42X/main/offapi/com/sun/star/embed/XEmbeddedClient.idl (revision d7a630b93db4316516c543e21eb4f4faf6d62bb4)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_embed_XEmbeddedClient_idl__
24cdf0e10cSrcweir#define __com_sun_star_embed_XEmbeddedClient_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_embed_WrongStateException_idl__
31cdf0e10cSrcweir#include <com/sun/star/embed/WrongStateException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir#ifndef __com_sun_star_embed_XComponentSupplier_idl__
35cdf0e10cSrcweir#include <com/sun/star/embed/XComponentSupplier.idl>
36cdf0e10cSrcweir#endif
37cdf0e10cSrcweir
38cdf0e10cSrcweir#ifndef __com_sun_star_embed_ObjectSaveVetoException_idl__
39cdf0e10cSrcweir#include <com/sun/star/embed/ObjectSaveVetoException.idl>
40cdf0e10cSrcweir#endif
41cdf0e10cSrcweir
42cdf0e10cSrcweir
43cdf0e10cSrcweir
44cdf0e10cSrcweir//============================================================================
45cdf0e10cSrcweir
46cdf0e10cSrcweir module com {  module sun {  module star {  module embed {
47cdf0e10cSrcweir
48cdf0e10cSrcweir//============================================================================
49cdf0e10cSrcweir/** represents common functionality for embedded clients.
50cdf0e10cSrcweir */
51cdf0e10cSrcweirpublished interface XEmbeddedClient: XComponentSupplier
52cdf0e10cSrcweir{
53cdf0e10cSrcweir    //------------------------------------------------------------------------
54cdf0e10cSrcweir    /** asks client to let the object store itself.
55cdf0e10cSrcweir
56cdf0e10cSrcweir        @throws com::sun::star::uno::ObjectSaveVetoException
57*a893be29SPedro Giffuni            in case container wants to avoid saving of object
58cdf0e10cSrcweir
59cdf0e10cSrcweir        @throws com::sun::star::uno::Exception
60cdf0e10cSrcweir            in case of problems during saving
61cdf0e10cSrcweir     */
62cdf0e10cSrcweir    void saveObject()
63cdf0e10cSrcweir        raises( ::com::sun::star::embed::ObjectSaveVetoException,
64cdf0e10cSrcweir                ::com::sun::star::uno::Exception );
65cdf0e10cSrcweir
66cdf0e10cSrcweir    //------------------------------------------------------------------------
67cdf0e10cSrcweir    /** An object can use this method to notify the client when the object
68cdf0e10cSrcweir        outplace window becomes visible or invisible.
69cdf0e10cSrcweir
70cdf0e10cSrcweir        @param bVisible
71cdf0e10cSrcweir            visibility state of the window
72cdf0e10cSrcweir
73cdf0e10cSrcweir        @throws com::sun::star::embed::WrongStateException
74cdf0e10cSrcweir            the object is in wrong state
75cdf0e10cSrcweir     */
76cdf0e10cSrcweir    void visibilityChanged( [in] boolean bVisible )
77cdf0e10cSrcweir        raises( ::com::sun::star::embed::WrongStateException );
78cdf0e10cSrcweir
79cdf0e10cSrcweir};
80cdf0e10cSrcweir
81cdf0e10cSrcweir//============================================================================
82cdf0e10cSrcweir
83cdf0e10cSrcweir}; }; }; };
84cdf0e10cSrcweir
85cdf0e10cSrcweir#endif
86