xref: /trunk/main/offapi/com/sun/star/drawing/CustomShape.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_drawing_CustomShape_idl__
#define __com_sun_star_drawing_CustomShape_idl__

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

#ifndef __com_sun_star_drawing_FillProperties_idl__
#include <com/sun/star/drawing/FillProperties.idl>
#endif

#ifndef __com_sun_star_drawing_LineProperties_idl__
#include <com/sun/star/drawing/LineProperties.idl>
#endif

#ifndef __com_sun_star_drawing_ShadowProperties_idl__
#include <com/sun/star/drawing/ShadowProperties.idl>
#endif

#ifndef __com_sun_star_drawing_Text_idl__
#include <com/sun/star/drawing/Text.idl>
#endif

#ifndef __com_sun_star_drawing_RotationDescriptor_idl__
#include <com/sun/star/drawing/RotationDescriptor.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 service is for a CustomShape
 */
service CustomShape
{
	service com::sun::star::drawing::Shape;

	service com::sun::star::drawing::FillProperties;

	service com::sun::star::drawing::LineProperties;

	service com::sun::star::drawing::ShadowProperties;

	service com::sun::star::drawing::Text;

	service com::sun::star::drawing::RotationDescriptor;

	//-------------------------------------------------------------------------
	/** This property contains the CustomShapeEngine service name that has to
	    be used for rendering.
	*/
	[property] string CustomShapeEngine;

	//-------------------------------------------------------------------------
	/** This property can be used to store data that the CustomShapeEngine may
	    use for rendering
	*/
	[optional, property] string CustomShapeData;

	//-------------------------------------------------------------------------
	/** This property describes the geometry of the CustomShape. The CustomShapeEngine
	    that is used should be able to get on with the content of this property.

	    If the CustomShapeEngine property is "com.sun.star.drawing.EnhancedCustomShapeEngine",
	    then this property is containing properties as they are specified in the service
	    com.sun.star.drawing.EnhancedCustomShapeGeometry
	*/
	[optional, property] sequence<::com::sun::star::beans::PropertyValue> CustomShapeGeometry;

	//-------------------------------------------------------------------------
	/**	This property describes the URL to a replacement graphic that could
		be displayed if the CustomShape engine is not available.
	*/
	[optional, property] string CustomShapeReplacementURL;

	//-------------------------------------------------------------------------
};

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

}; }; }; };

#endif