summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/drawing/AppletShape.idl
blob: df8131492543a815f4764555e08605fe239f44cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_drawing_AppletShape_idl__
#define __com_sun_star_drawing_AppletShape_idl__

#include <com/sun/star/drawing/Shape.idl>
#include <com/sun/star/beans/PropertyValue.idl>

//=============================================================================

module com { module sun { module star { module drawing { 

//=============================================================================
/** This <type>Shape</type> encapsulates an applet.

    <p> An applet is a small Java-based program that is executed and rendered
        embedded in a document.
*/
published service AppletShape
{
    /** basic service for position, size and z-order. 
        
        <p>A <type>AppletShape</type> cannot be rotated.
     */
    service com::sun::star::drawing::Shape;

    //------------------------------------------------------------------------- 

    /** This property specifies the base URI for the applet.
        
        <p>If this property is empty, then it defaults the same base URI as for
        the current document.
    */
    [property] string AppletCodeBase;

    //------------------------------------------------------------------------- 

    /** this is an optional name for the applet.
    */
    [property] string AppletName;

    //------------------------------------------------------------------------- 

    /** This property specifies one of the following:
        <br>The name of the class file that contains the compiled applet subclass.
        <br>The path to the class, including the class file itself.
    */
    [property] string AppletCode;

    //------------------------------------------------------------------------- 

    /** This sequence contains parameters that are passed to the applet
        when it is initialized.
    */
    [property] sequence< com::sun::star::beans::PropertyValue > AppletCommands;

    //------------------------------------------------------------------------- 

    /** This property specifies whether or not the applet can be scripted.
    */
    [readonly, property] boolean AppletIsScript;
};

//=============================================================================

}; }; }; }; 

#endif