offapi/com/sun/star/drawing/AppletShape.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_drawing_AppletShape_idl__
  20 #define __com_sun_star_drawing_AppletShape_idl__
  21
  22 #include <com/sun/star/drawing/Shape.idl>
  23 #include <com/sun/star/beans/PropertyValue.idl>
  24
  25
  26 module com { module sun { module star { module drawing {
  27
  28 /** This Shape encapsulates an applet.
  29
  30     <p> An applet is a small Java-based program that is executed and rendered
  31         embedded in a document.
  32 */
  33 published service AppletShape
  34 {
  35     /** basic service for position, size and z-order.
  36
  37         <p>A AppletShape cannot be rotated.
  38      */
  39     service com::sun::star::drawing::Shape;
  40
  41
  42     /** This property specifies the base URI for the applet.
  43
  44         <p>If this property is empty, then it defaults the same base URI as for
  45         the current document.
  46     */
  47     [property] string AppletCodeBase;
  48
  49
  50     /** this is an optional name for the applet.
  51     */
  52     [property] string AppletName;
  53
  54
  55     /** This property specifies one of the following:
  56         <br>The name of the class file that contains the compiled applet subclass.
  57         <br>The path to the class, including the class file itself.
  58     */
  59     [property] string AppletCode;
  60
  61
  62     /** This sequence contains parameters that are passed to the applet
  63         when it is initialized.
  64     */
  65     [property] sequence< com::sun::star::beans::PropertyValue > AppletCommands;
  66
  67
  68     /** This property specifies whether or not the applet can be scripted.
  69     */
  70     [readonly, property] boolean AppletIsScript;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */