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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: EmbeddedObjectDescriptor.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_embed_EmbeddedObjectDescriptor_idl__
  31 #define __com_sun_star_embed_EmbeddedObjectDescriptor_idl__
  32
  33 #ifndef __com_sun_star_io_XInputStream_idl__
  34 #include <com/sun/star/io/XInputStream.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_Rectangle_idl__
  38 #include <com/sun/star/awt/Rectangle.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_URL_idl__
  42 #include <com/sun/star/util/URL.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_task_XInteractionHandler_idl__
  46 #include <com/sun/star/task/XInteractionHandler.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_task_XStatusIndicator_idl__
  50 #include <com/sun/star/task/XStatusIndicator.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_frame_XDispatchProviderInterceptor_idl__
  54 #include <com/sun/star/frame/XDispatchProviderInterceptor.idl>
  55 #endif
  56
  57 //============================================================================
  58
  59 module com { module sun { module star { module embed {
  60
  61 //============================================================================
  62 /** describes properties of an embedded object
  63
  64     <p>
  65     This service may be represented by a
  66     <type scope="com::sun::star::beans" dim="[]">PropertyValue</type>.
  67     Such descriptors will be passed to different functions, included into
  68     possible load/save proccesses. Every member of such process can use
  69     this descriptor and may change it to actualize the informations about
  70     the object. So this descriptor should be used as an in/out parameter.
  71     </p>
  72
  73     @see com::sun::star::beans::PropertyValue
  74  */
  75 service EmbeddedObjectDescriptor
  76 {
  77     //------------------------------------------------------------------------
  78     /** lets the graphical representation of embedded document be stored.
  79
  80         <p>
  81         Setting of this property to true tells the embedded object that
  82         controlls the document to store or not to store the graphical
  83         representation of the document in to the object persistence.
  84         If this property is not set the object makes the decision itself.
  85         </p>
  86     */
  87     [optional,property] boolean StoreVisualReplacement;
  88
  89     //------------------------------------------------------------------------
  90     /** allows to provide a dispatch interceptor for outplace activation.
  91     */
  92     [optional,property] ::com::sun::star::frame::XDispatchProviderInterceptor
  93                                                 OutplaceDispatchInterceptor;
  94
  95 };
  96
  97 //============================================================================
  98
  99 }; }; }; };
 100
 101 #endif
 102