offapi/com/sun/star/drawing/EnhancedCustomShapeGeometry.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: EnhancedCustomShapeGeometry.idl,v $
  10  * $Revision: 1.4 $
  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_EnhancedCustomShapeGeometry_idl__
  31 #define __com_sun_star_drawing_EnhancedCustomShapeGeometry_idl__
  32
  33 #ifndef __com_sun_star_awt_Rectangle_idl__
  34 #include <com/sun/star/awt/Rectangle.idl>
  35 #endif
  36 #ifndef __com_sun_star_beans_PropertyValue_idl__
  37 #include <com/sun/star/beans/PropertyValue.idl>
  38 #endif
  39 #ifndef __com_sun_star_beans_PropertyValues_idl__
  40 #include <com/sun/star/beans/PropertyValues.idl>
  41 #endif
  42 #ifndef __com_sun_star_drawing_EnhancedCustomShapeHandle_idl__
  43 #include <com/sun/star/drawing/EnhancedCustomShapeHandle.idl>
  44 #endif
  45 #ifndef __com_sun_star_drawing_EnhancedCustomShapeAdjustmentValue_idl__
  46 #include <com/sun/star/drawing/EnhancedCustomShapeAdjustmentValue.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51 module com { module sun { module star { module drawing {
  52
  53 //=============================================================================
  54 /**
  55   This service may be represented by a ::com::sun::star::beans::PropertyValue [].
  56 */
  57
  58 service EnhancedCustomShapeGeometry
  59 {
  60     /**
  61         The Type attribute contains the name of a shape type. This name can be
  62         used to offer specialized user interfaces for certain classes of shapes, like
  63         for arrows, smileys, etc. The shape type is rendering engine dependent and does
  64         not influence the geometry of the shape. If the value of the draw:type
  65         attribute is non-primitive, then no shape type is available.
  66     */
  67     [property] string Type;
  68
  69     /** This property describes the user space of the shape in its canonical form
  70     */
  71     [optional, property] ::com::sun::star::awt::Rectangle ViewBox;
  72
  73     /** This property specifies if the orientation of the shape is horizontal mirrored.
  74     */
  75     [optional, property] boolean MirroredX;
  76
  77     /** This property specifies if the orientation of the shape is vertical mirrored.
  78     */
  79     [optional, property] boolean MirroredY;
  80
  81     /** This property specifies the text rotation angle in degrees. The text rotation is added
  82         to the shape geometry rotation.
  83     */
  84     [optional, property] double TextRotateAngle;
  85
  86     /** This property specifies a sequence of Adjustment values.
  87     */
  88     [optional, property] sequence<::com::sun::star::drawing::EnhancedCustomShapeAdjustmentValue> AdjustmentValues;
  89
  90     /** This property sequence is including the extrusion description, the properties
  91         are as same as specified in the service com::sun::star:drawing::EnhancedCustomShapeExtrusion
  92     */
  93     [optional, property] sequence<::com::sun::star::beans::PropertyValue> Extrusion;
  94
  95     /** This property sequence is including the path description, the properties
  96         are as same as specified in the service com::sun::star:drawing::EnhancedCustomShapePath
  97     */
  98     [optional, property] sequence<::com::sun::star::beans::PropertyValue> Path;
  99
 100     /** This property sequence is including the textpath description, the properties
 101         are as same as specified in the service com::sun::star:drawing::EnhancedCustomShapeTextPath
 102     */
 103     [optional, property] sequence<::com::sun::star::beans::PropertyValue> TextPath;
 104
 105     /** This property is describing the equations that are used, each equation can be referenced
 106         by com::sun::star::drawing::EnhancedCustomShapeParameter which are often used in Path, Extrusion
 107         and or Handle descriptions.
 108     */
 109     [optional, property] sequence<string> Equations;
 110
 111     /** This property is describing the interaction handles that are used, each inner property sequence
 112         is having the same properties as they are specified in the service com::sun::star:drawing::EnhancedCustomShapeHandle
 113     */
 114     [optional, property] sequence<::com::sun::star::beans::PropertyValues> Handles;
 115 };
 116
 117 //=============================================================================
 118
 119 }; }; }; };
 120
 121 #endif
 122