offapi/com/sun/star/embed/EmbeddedObjectDescriptor.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 #ifndef __com_sun_star_embed_EmbeddedObjectDescriptor_idl__
  20 #define __com_sun_star_embed_EmbeddedObjectDescriptor_idl__
  21
  22 #include <com/sun/star/io/XInputStream.idl>
  23 #include <com/sun/star/awt/Rectangle.idl>
  24 #include <com/sun/star/util/URL.idl>
  25 #include <com/sun/star/task/XInteractionHandler.idl>
  26 #include <com/sun/star/task/XStatusIndicator.idl>
  27 #include <com/sun/star/frame/XDispatchProviderInterceptor.idl>
  28 #include <com/sun/star/embed/XStorage.idl>
  29
  30
  31 module com { module sun { module star { module embed {
  32
  33 /** describes properties of an embedded object
  34
  35     <p>
  36     This service may be represented by a
  37     com::sun::star::beansPropertyValue[].
  38     Such descriptors will be passed to different functions, included into
  39     possible load/save processes. Every member of such process can use
  40     this descriptor and may change it to actualize the information about
  41     the object. So this descriptor should be used as an in/out parameter.
  42     </p>
  43
  44     @see com::sun::star::beans::PropertyValue
  45  */
  46 published service EmbeddedObjectDescriptor
  47 {
  48     /** lets the graphical representation of embedded document be stored.
  49
  50         <p>
  51         Setting of this property to true tells the embedded object that
  52         controls the document to store or not to store the graphical
  53         representation of the document in to the object persistence.
  54         If this property is not set the object makes the decision itself.
  55         </p>
  56     */
  57     [optional,property] boolean StoreVisualReplacement;
  58
  59     /** allows to provide a dispatch interceptor for outplace activation.
  60     */
  61     [optional,property] ::com::sun::star::frame::XDispatchProviderInterceptor
  62                                                 OutplaceDispatchInterceptor;
  63
  64     /** denotes the storage from which the embedded object is to be recovered.
  65
  66         <p>Upon activating the embedded object, it is normally loaded from a storage as denoted by
  67         the parameters to the XEmbedObjectCreator method calls.</p>
  68
  69         <p>You can pass a non-`NULL` <code>RecoveryStorage</code> in the object descriptor if you wish to load the
  70         embedded object from an alternate storage.</p>
  71
  72         <p>The object will still be based on the storage denoted in the <code>XEmbedObjectCreator</code> method
  73         call, i.e., subsequent save operations will still use that storage. <code>RecoveryStorage</code> is used
  74         at loading time only, and then discarded.</p>
  75     */
  76     [optional, property] XStorage RecoveryStorage;
  77 };
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */