offapi/com/sun/star/embed/EmbeddedObjectDescriptor.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_EmbeddedObjectDescriptor_idl__
  28 #define __com_sun_star_embed_EmbeddedObjectDescriptor_idl__
  29
  30 #ifndef __com_sun_star_io_XInputStream_idl__
  31 #include <com/sun/star/io/XInputStream.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_awt_Rectangle_idl__
  35 #include <com/sun/star/awt/Rectangle.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_URL_idl__
  39 #include <com/sun/star/util/URL.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_task_XInteractionHandler_idl__
  43 #include <com/sun/star/task/XInteractionHandler.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_task_XStatusIndicator_idl__
  47 #include <com/sun/star/task/XStatusIndicator.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__
  51 #include <com/sun/star/frame/XDispatchProviderInterceptor.idl>
  52 #endif
  53
  54 #include <com/sun/star/embed/XStorage.idl>
  55
  56 //============================================================================
  57
  58 module com { module sun { module star { module embed {
  59
  60 //============================================================================
  61 /** describes properties of an embedded object
  62
  63     <p>
  64     This service may be represented by a
  65     <type scope="com::sun::star::beans" dim="[]">PropertyValue</type>.
  66     Such descriptors will be passed to different functions, included into
  67     possible load/save proccesses. Every member of such process can use
  68     this descriptor and may change it to actualize the informations about
  69     the object. So this descriptor should be used as an in/out parameter.
  70     </p>
  71
  72     @see com::sun::star::beans::PropertyValue
  73  */
  74 published service EmbeddedObjectDescriptor
  75 {
  76     //------------------------------------------------------------------------
  77     /** lets the graphical representation of embedded document be stored.
  78
  79         <p>
  80         Setting of this property to true tells the embedded object that
  81         controlls the document to store or not to store the graphical
  82         representation of the document in to the object persistence.
  83         If this property is not set the object makes the decision itself.
  84         </p>
  85     */
  86     [optional,property] boolean StoreVisualReplacement;
  87
  88     //------------------------------------------------------------------------
  89     /** allows to provide a dispatch interceptor for outplace activation.
  90     */
  91     [optional,property] ::com::sun::star::frame::XDispatchProviderInterceptor
  92                                                 OutplaceDispatchInterceptor;
  93
  94     /** denotes the storage from which the embedded object is to be recovered.
  95
  96         <p>Upon activating the embedded object, it is normally loaded from a storage as denoted by
  97         the parameters to the <type>XEmbedObjectCreator</type> method calls.</p>
  98
  99         <p>You can pass a non-<NULL/> <code>RecoveryStorage</code> in the object descriptor if you wish to load the
 100         embedded object from an alternate storage.</p>
 101
 102         <p>The object will still be based on the storage denoted in the <code>XEmbedObjectCreator</code> method
 103         call, i.e., subsequent save operations will still use that storage. <code>RecoveryStorage</code> is used
 104         at loading time only, and then discarded.</p>
 105     */
 106     [optional, property] XStorage RecoveryStorage;
 107 };
 108
 109 //============================================================================
 110
 111 }; }; }; };
 112
 113 #endif
 114