offapi/com/sun/star/drawing/AppletShape.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: AppletShape.idl,v $
  10  * $Revision: 1.6 $
  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_drawing_AppletShape_idl__
  31 #define __com_sun_star_drawing_AppletShape_idl__
  32
  33 #ifndef __com_sun_star_drawing_Shape_idl__
  34 #include <com/sun/star/drawing/Shape.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module drawing {
  44
  45 //=============================================================================
  46 /** This <type>Shape</type> encapsulates an applet.
  47
  48     <p> An applet is a small Java-based program that is executed and rendered
  49         embedded in a document.
  50 */
  51 published service AppletShape
  52 {
  53     /** basic service for position, size and z-order.
  54
  55         <p>A <type>AppletShape</type> cannot be rotated.
  56      */
  57     service com::sun::star::drawing::Shape;
  58
  59     //-------------------------------------------------------------------------
  60
  61     /** This property specifies the base URI for the applet.
  62
  63         <p>If this property is empty, then it defaults the same base URI as for
  64         the current document.
  65     */
  66     [property] string AppletCodeBase;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** this is an optional name for the applet.
  71     */
  72     [property] string AppletName;
  73
  74     //-------------------------------------------------------------------------
  75
  76     /** This property specifies one of the following:
  77         <br>The name of the class file that contains the compiled applet subclass.
  78         <br>The path to the class, including the class file itself.
  79     */
  80     [property] string AppletCode;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** This sequence contains paramaters that are passed to the applet
  85         when it is initialized.
  86     */
  87     [property] sequence< com::sun::star::beans::PropertyValue > AppletCommands;
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** This property specifies whether or not the applet can be scripted.
  92     */
  93     [readonly, property] boolean AppletIsScript;
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 #endif
 101