offapi/com/sun/star/text/TextEmbeddedObject.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: TextEmbeddedObject.idl,v $
  10  * $Revision: 1.12 $
  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_text_TextEmbeddedObject_idl__
  31 #define __com_sun_star_text_TextEmbeddedObject_idl__
  32
  33 #ifndef __com_sun_star_document_XEmbeddedObjectSupplier_idl__
  34 #include <com/sun/star/document/XEmbeddedObjectSupplier.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_text_BaseFrame_idl__
  38 #include <com/sun/star/text/BaseFrame.idl>
  39 #endif
  40 #ifndef __com_sun_star_frame_XModel_idl__
  41 #include <com/sun/star/frame/XModel.idl>
  42 #endif
  43
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module text {
  48
  49 //=============================================================================
  50
  51 // DocMerge from xml: service com::sun::star::text::TextEmbeddedObject
  52 /** provides access to the properties and methods of an embedded object.
  53  */
  54 published service TextEmbeddedObject
  55 {
  56     /** contains the definition of interfaces and properties that are supported by text frames,
  57      graphic objects and embeddedobjects.
  58      */
  59     service BaseFrame;
  60     // DocMerge: empty anyway
  61     interface com::sun::star::document::XEmbeddedObjectSupplier;
  62         /* If you get this property you get the CLSID of the OLE2 document stream
  63                 contained in this OLE2 shape. If you set it, an empty OLE2 document stream
  64                 with this CLSID is created within this OLE2 shape.
  65             The property can only be set as long as the object is not inserted into the document.
  66         */
  67         [property] string CLSID;
  68         //-------------------------------------------------------------------------
  69
  70         /** This is the model for the OLE2 object.
  71             <p>This property if void if the ole2 is not an
  72             Office component.</p>
  73
  74         */
  75         [readonly, maybevoid, property] com::sun::star::frame::XModel Model;
  76         //-------------------------------------------------------------------------
  77
  78         /** This is the component for the OLE2 object.
  79
  80         */
  81         [readonly, maybevoid, property] com::sun::star::lang::XComponent Component;
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif