offapi/com/sun/star/drawing/MeasureProperties.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: MeasureProperties.idl,v $
  10  * $Revision: 1.11 $
  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_MeasureProperties_idl__
  31 #define __com_sun_star_drawing_MeasureProperties_idl__
  32
  33 #ifndef __com_sun_star_drawing_MeasureKind_idl__
  34 #include <com/sun/star/drawing/MeasureKind.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_MeasureTextHorzPos_idl__
  38 #include <com/sun/star/drawing/MeasureTextHorzPos.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_MeasureTextVertPos_idl__
  42 #include <com/sun/star/drawing/MeasureTextVertPos.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module drawing {
  49
  50 //=============================================================================
  51
  52 /** This service describes a <type>MeasureShape</type>.
  53  */
  54 published service MeasureProperties
  55 {
  56     //-------------------------------------------------------------------------
  57     /** If this property is <TRUE/>, the measure is drawn below the
  58         reference edge instead of above it.
  59      */
  60     [property] boolean MeasureBelowReferenceEdge;
  61
  62     //-------------------------------------------------------------------------
  63     /** This is the length of the first help line.
  64      */
  65     [property] long MeasureHelpLine1Length;
  66
  67     //-------------------------------------------------------------------------
  68     /** This is the length of the second help line.
  69      */
  70     [property] long MeasureHelpLine2Length;
  71
  72     //-------------------------------------------------------------------------
  73     /** This is the distance from the measure line to the start of the
  74         help lines.
  75      */
  76     [property] long MeasureHelpLineDistance;
  77
  78     //-------------------------------------------------------------------------
  79     /** This is the overhang of the two help lines.
  80      */
  81     [property] long MeasureHelpLineOverhang;
  82
  83     //-------------------------------------------------------------------------
  84     /** This enumeration specifies the <type>MeasureKind</type>.
  85      */
  86     [property] com::sun::star::drawing::MeasureKind MeasureKind;
  87
  88     //-------------------------------------------------------------------------
  89     /** This is the distance from the reference edge to the measure line.
  90      */
  91     [property] long MeasureLineDistance;
  92
  93     //-------------------------------------------------------------------------
  94     /** This is the overhang of the reference line over the help lines.
  95      */
  96     [property] long MeasureOverhang;
  97
  98     //-------------------------------------------------------------------------
  99     /** If this is <TRUE/>, the unit of measure is shown in the measure text.
 100      */
 101     [property] boolean MeasureShowUnit;
 102
 103     //-------------------------------------------------------------------------
 104     /** If this is <TRUE/>, the angle of the measure is set automatically.
 105      */
 106     [property] boolean MeasureTextAutoAngle;
 107
 108     //-------------------------------------------------------------------------
 109     /** This is the automatic angle.
 110      */
 111     [property] long MeasureTextAutoAngleView;
 112
 113     //-------------------------------------------------------------------------
 114     /** This is the fixed angle.
 115      */
 116     [property] long MeasureTextFixedAngle;
 117
 118     //-------------------------------------------------------------------------
 119     /** This is the horizontal position of the measure text.
 120      */
 121     [property] com::sun::star::drawing::MeasureTextHorzPos MeasureTextHorizontalPosition;
 122
 123     //-------------------------------------------------------------------------
 124     /** This is the vertical position of the text.
 125      */
 126     [property] com::sun::star::drawing::MeasureTextVertPos MeasureTextVerticalPosition;
 127
 128     //-------------------------------------------------------------------------
 129     /** If this value is <TRUE/>, the measure has a fixed angle.
 130      */
 131     [property] boolean MeasureTextIsFixedAngle;
 132
 133     //-------------------------------------------------------------------------
 134     /** If this value is <TRUE/>, the text is rotated 90 degrees.
 135      */
 136     [property] boolean MeasureTextRotate90;
 137
 138     //-------------------------------------------------------------------------
 139     /** If this value is <TRUE/>, the text is printed upside down.
 140      */
 141     [property] boolean MeasureTextUpsideDown;
 142
 143     //-------------------------------------------------------------------------
 144     /** This value is the number of decimal places that is used to format the
 145         measure value.
 146
 147         @since OOo 1.1.2
 148      */
 149     [optional, property] short MeasureDecimalPlaces;
 150  };
 151
 152 //=============================================================================
 153
 154 }; }; }; };
 155
 156 #endif
 157