1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_embed_EmbeddedObjectDescriptor_idl__
24#define __com_sun_star_embed_EmbeddedObjectDescriptor_idl__
25
26#ifndef __com_sun_star_io_XInputStream_idl__
27#include <com/sun/star/io/XInputStream.idl>
28#endif
29
30#ifndef __com_sun_star_awt_Rectangle_idl__
31#include <com/sun/star/awt/Rectangle.idl>
32#endif
33
34#ifndef __com_sun_star_util_URL_idl__
35#include <com/sun/star/util/URL.idl>
36#endif
37
38#ifndef __com_sun_star_task_XInteractionHandler_idl__
39#include <com/sun/star/task/XInteractionHandler.idl>
40#endif
41
42#ifndef __com_sun_star_task_XStatusIndicator_idl__
43#include <com/sun/star/task/XStatusIndicator.idl>
44#endif
45
46#ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__
47#include <com/sun/star/frame/XDispatchProviderInterceptor.idl>
48#endif
49
50#include <com/sun/star/embed/XStorage.idl>
51
52//============================================================================
53
54module com { module sun { module star { module embed {
55
56//============================================================================
57/** describes properties of an embedded object
58
59    <p>
60    This service may be represented by a
61    <type scope="com::sun::star::beans" dim="[]">PropertyValue</type>.
62    Such descriptors will be passed to different functions, included into
63	possible load/save proccesses. Every member of such process can use
64	this descriptor and may change it to actualize the informations about
65	the object. So this descriptor should be used as an in/out parameter.
66    </p>
67
68	@see com::sun::star::beans::PropertyValue
69 */
70published service EmbeddedObjectDescriptor
71{
72	//------------------------------------------------------------------------
73    /** lets the graphical representation of embedded document be stored.
74
75        <p>
76        Setting of this property to true tells the embedded object that
77		controls the document to store or not to store the graphical
78		representation of the document in to the object persistence.
79		If this property is not set the object makes the decision itself.
80        </p>
81    */
82    [optional,property] boolean StoreVisualReplacement;
83
84	//------------------------------------------------------------------------
85    /** allows to provide a dispatch interceptor for outplace activation.
86    */
87    [optional,property] ::com::sun::star::frame::XDispatchProviderInterceptor
88												OutplaceDispatchInterceptor;
89
90    /** denotes the storage from which the embedded object is to be recovered.
91
92        <p>Upon activating the embedded object, it is normally loaded from a storage as denoted by
93        the parameters to the <type>XEmbedObjectCreator</type> method calls.</p>
94
95        <p>You can pass a non-<NULL/> <code>RecoveryStorage</code> in the object descriptor if you wish to load the
96        embedded object from an alternate storage.</p>
97
98        <p>The object will still be based on the storage denoted in the <code>XEmbedObjectCreator</code> method
99        call, i.e., subsequent save operations will still use that storage. <code>RecoveryStorage</code> is used
100        at loading time only, and then discarded.</p>
101    */
102    [optional, property] XStorage RecoveryStorage;
103};
104
105//============================================================================
106
107}; }; }; };
108
109#endif
110
111