offapi/com/sun/star/drawing/CaptionShape.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: CaptionShape.idl,v $
  10  * $Revision: 1.6 $
  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_CaptionShape_idl__
  31 #define __com_sun_star_drawing_CaptionShape_idl__
  32
  33 #ifndef __com_sun_star_drawing_Shape_idl__
  34 #include <com/sun/star/drawing/Shape.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_Text_idl__
  38 #include <com/sun/star/drawing/Text.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_FillProperties_idl__
  42 #include <com/sun/star/drawing/FillProperties.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_drawing_LineProperties_idl__
  46 #include <com/sun/star/drawing/LineProperties.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_drawing_ShadowProperties_idl__
  50 #include <com/sun/star/drawing/ShadowProperties.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_drawing_RotationDescriptor_idl__
  54 #include <com/sun/star/drawing/RotationDescriptor.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_awt_Point_idl__
  58 #include <com/sun/star/awt/Point.idl>
  59 #endif
  60
  61 //=============================================================================
  62
  63  module com {  module sun {  module star {  module drawing {
  64
  65 //=============================================================================
  66
  67 /** The <type>CaptionShape</type> represents a rectangular drawing shape
  68     with an additional set of lines. It can be used as a description for
  69     a fixed point inside a drawing.
  70  */
  71 published service CaptionShape
  72 {
  73     /** the position and size is only used for the
  74         caption area
  75     */
  76     service com::sun::star::drawing::Shape;
  77
  78     service com::sun::star::drawing::FillProperties;
  79
  80     service com::sun::star::drawing::LineProperties;
  81
  82     service com::sun::star::drawing::ShadowProperties;
  83
  84     service com::sun::star::drawing::Text;
  85
  86     service com::sun::star::drawing::RotationDescriptor;
  87
  88     /** This is the radius of the caption area corners.
  89      */
  90     [property] long CornerRadius;
  91
  92     /** The caption point property specify the position of
  93         the point that is captioned. A set of lines are
  94         rendered from the caption area.
  95     */
  96     [property] com::sun::star::awt::Point CaptionPoint;
  97
  98     /** This property specifies the geometry of the line of a caption.
  99
 100         @see CaptionType
 101     */
 102     [property] short CaptionType;
 103
 104     /** This property specifies if the escape angle of
 105         the line of a caption is fixed or free. If this
 106         is set to <false/>, the application can choose
 107         the best possible angle. If not, the value in
 108         <code>CaptionAngle</code> is used.
 109     */
 110     [property] boolean CaptionIsFixedAngle;
 111
 112     /** This property specifies the escape angle of
 113         the line of a caption.
 114         It is only used if <code>CaptionIsFixedAngle</code>
 115         is set to <true/>
 116     */
 117     [property] long CaptionAngle;
 118
 119     /** This property specifies the distance between the
 120         text area of the caption and the start of the line.
 121     */
 122     [property] long CaptionGap;
 123
 124     /** This property specifies the escape direction for the
 125         line of a caption.
 126
 127         @see CaptionEscapeDirection
 128     */
 129     [property] long CaptionEscapeDirection;
 130
 131     /** If this property is <true/>, the property <code>CaptionEscapeRelative</code>
 132         is used, else the property <code>CaptionEscapeAbsolute</code> is used.
 133     */
 134     [property] boolean CaptionIsEscapeRelative;
 135
 136     /** This property specifies the relativ escape distance for
 137         the line of a caption.
 138     */
 139     [property] long CaptionEscapeRelative;
 140
 141     /** This property specifies the absolut escape distance for
 142         the line of a caption.
 143     */
 144     [property] long CaptionEscapeAbsolute;
 145
 146     /** This property specifies the length of the caption line.
 147     */
 148     [property] long CaptionLineLength;
 149
 150     /** If this property is <true/>, the application determines
 151         the best possible length for the caption line.
 152     */
 153     [property] boolean CaptionIsFitLineLength;
 154 };
 155
 156 //=============================================================================
 157
 158 }; }; }; };
 159
 160 #endif
 161