xref: /AOO41X/main/offapi/com/sun/star/drawing/AppletShape.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_drawing_AppletShape_idl__
24#define __com_sun_star_drawing_AppletShape_idl__
25
26#ifndef __com_sun_star_drawing_Shape_idl__
27#include <com/sun/star/drawing/Shape.idl>
28#endif
29
30#ifndef __com_sun_star_beans_PropertyValue_idl__
31#include <com/sun/star/beans/PropertyValue.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module drawing {
37
38//=============================================================================
39/** This <type>Shape</type> encapsulates an applet.
40
41    <p> An applet is a small Java-based program that is executed and rendered
42        embedded in a document.
43*/
44published service AppletShape
45{
46    /** basic service for position, size and z-order.
47
48        <p>A <type>AppletShape</type> cannot be rotated.
49     */
50    service com::sun::star::drawing::Shape;
51
52    //-------------------------------------------------------------------------
53
54    /** This property specifies the base URI for the applet.
55
56        <p>If this property is empty, then it defaults the same base URI as for
57        the current document.
58    */
59    [property] string AppletCodeBase;
60
61    //-------------------------------------------------------------------------
62
63    /** this is an optional name for the applet.
64    */
65    [property] string AppletName;
66
67    //-------------------------------------------------------------------------
68
69    /** This property specifies one of the following:
70        <br>The name of the class file that contains the compiled applet subclass.
71        <br>The path to the class, including the class file itself.
72    */
73    [property] string AppletCode;
74
75    //-------------------------------------------------------------------------
76
77    /** This sequence contains paramaters that are passed to the applet
78        when it is initialized.
79    */
80    [property] sequence< com::sun::star::beans::PropertyValue > AppletCommands;
81
82    //-------------------------------------------------------------------------
83
84    /** This property specifies whether or not the applet can be scripted.
85    */
86    [readonly, property] boolean AppletIsScript;
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94
95