offapi/com/sun/star/text/TextEmbeddedObject.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_text_TextEmbeddedObject_idl__
  20 #define __com_sun_star_text_TextEmbeddedObject_idl__
  21
  22 #include <com/sun/star/document/XEmbeddedObjectSupplier.idl>
  23 #include <com/sun/star/text/BaseFrame.idl>
  24 #include <com/sun/star/frame/XModel.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module text {
  29
  30 /** provides access to the properties and methods of an embedded object.
  31  */
  32 published service TextEmbeddedObject
  33 {
  34     /** contains the definition of interfaces and properties that are supported by text frames,
  35      graphic objects and embedded objects.
  36      */
  37     service BaseFrame;
  38     interface com::sun::star::document::XEmbeddedObjectSupplier;
  39         /* If you get this property you get the CLSID of the OLE2 document stream
  40                 contained in this OLE2 shape. If you set it, an empty OLE2 document stream
  41                 with this CLSID is created within this OLE2 shape.
  42             The property can only be set as long as the object is not inserted into the document.
  43         */
  44         [property] string CLSID;
  45
  46         /** This is the model for the OLE2 object.
  47             <p>This property if void if the OLE2 is not an
  48             Office component.</p>
  49
  50         */
  51         [readonly, maybevoid, property] com::sun::star::frame::XModel Model;
  52
  53         /** This is the component for the OLE2 object.
  54
  55         */
  56         [readonly, maybevoid, property] com::sun::star::lang::XComponent Component;
  57 };
  58
  59
  60 }; }; }; };
  61
  62 #endif
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */