offapi/com/sun/star/drawing/EnhancedCustomShapeHandle.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: EnhancedCustomShapeHandle.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_EnhancedCustomShapeHandle_idl__
  31 #define __com_sun_star_drawing_EnhancedCustomShapeHandle_idl__
  32
  33 #ifndef __com_sun_star_drawing_EnhancedCustomShapeParameterPair_idl__
  34 #include <com/sun/star/drawing/EnhancedCustomShapeParameterPair.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module drawing {
  40
  41 //=============================================================================
  42
  43 /**
  44   This service may be represented by a ::com::sun::star::beans::PropertyValue [].
  45 */
  46
  47 service EnhancedCustomShapeHandle
  48 {
  49     /** Specifies if the x position of the handle is mirrored.
  50     */
  51     [optional, property] boolean MirroredX;
  52
  53     /** Specifies if the y position of the handle is mirrored.
  54     */
  55     [optional, property] boolean MirroredY;
  56
  57     /** Specifies if the handle directions are swapped if the shape is taller than wide.
  58     */
  59     [optional, property] boolean Switched;
  60
  61     /** If the property Polar is set, then the first value specifies the radius and the second
  62         parameter the angle of the handle. Otherwise, if the handle is not polar, the first parameter
  63         specifies the horizontal handle position, the vertical handle position is described by the
  64         second parameter.
  65     */
  66     [optional, property] com::sun::star::drawing::EnhancedCustomShapeParameterPair Position;
  67
  68     /** If this attribute is set, the handle is a polar handle. The property specifies the center
  69         position of the handle. If this attribute is set, the attributes RangeX and RangeY are ignored,
  70         instead the attribute RadiusRange is used.
  71     */
  72     [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameterPair Polar;
  73
  74     /** If the attribute RangeXMinimum is set, it specifies the horizontal minimum range of the handle.
  75     */
  76     [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameter RangeXMinimum;
  77
  78     /** If the attribute RangeXMaximum is set, it specifies the horizontal maximum range of the handle.
  79     */
  80     [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameter RangeXMaximum;
  81
  82     /** If the attribute RangeYMinimum is set, it specifies the vertical minimum range of the handle.
  83     */
  84     [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameter RangeYMinimum;
  85
  86     /** If the attribute RangeYMaximum is set, it specifies the vertical maximum range of the handle.
  87     */
  88     [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameter RangeYMaximum;
  89
  90     /** If this attribute is set, it specifies the minimum radius range that can be used for a polar handle.
  91     */
  92     [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameter RadiusRangeMinimum;
  93
  94     /** If this attribute is set, it specifies the maximum radius range that can be used for a polar handle.
  95     */
  96     [optional, property] ::com::sun::star::drawing::EnhancedCustomShapeParameter RadiusRangeMaximum;
  97 };
  98
  99 //=============================================================================
 100
 101 }; }; }; };
 102
 103 #endif
 104