xref: /aoo41x/main/offapi/com/sun/star/drawing/AppletShape.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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__

#ifndef __com_sun_star_drawing_Shape_idl__
#include <com/sun/star/drawing/Shape.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

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

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 paramaters 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