offapi/com/sun/star/drawing/CaptionShape.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_drawing_CaptionShape_idl__
  20 #define __com_sun_star_drawing_CaptionShape_idl__
  21
  22 #include <com/sun/star/drawing/Shape.idl>
  23
  24 #include <com/sun/star/drawing/Text.idl>
  25 #include <com/sun/star/drawing/FillProperties.idl>
  26 #include <com/sun/star/drawing/LineProperties.idl>
  27
  28 #include <com/sun/star/drawing/ShadowProperties.idl>
  29
  30 #include <com/sun/star/drawing/RotationDescriptor.idl>
  31 #include <com/sun/star/awt/Point.idl>
  32
  33
  34  module com {  module sun {  module star {  module drawing {
  35
  36
  37 /** The CaptionShape represents a rectangular drawing shape
  38     with an additional set of lines. It can be used as a description for
  39     a fixed point inside a drawing.
  40  */
  41 published service CaptionShape
  42 {
  43     /** the position and size is only used for the
  44         caption area
  45     */
  46     service com::sun::star::drawing::Shape;
  47
  48     service com::sun::star::drawing::FillProperties;
  49
  50     service com::sun::star::drawing::LineProperties;
  51
  52     service com::sun::star::drawing::ShadowProperties;
  53
  54     service com::sun::star::drawing::Text;
  55
  56     service com::sun::star::drawing::RotationDescriptor;
  57
  58     /** This is the radius of the caption area corners.
  59      */
  60     [property] long CornerRadius;
  61
  62     /** The caption point property specify the position of
  63         the point that is captioned. A set of lines are
  64         rendered from the caption area.
  65     */
  66     [property] com::sun::star::awt::Point CaptionPoint;
  67
  68     /** This property specifies the geometry of the line of a caption.
  69
  70         @see CaptionType
  71     */
  72     [property] short CaptionType;
  73
  74     /** This property specifies if the escape angle of
  75         the line of a caption is fixed or free. If this
  76         is set to `FALSE`, the application can choose
  77         the best possible angle. If not, the value in
  78         <code>CaptionAngle</code> is used.
  79     */
  80     [property] boolean CaptionIsFixedAngle;
  81
  82     /** This property specifies the escape angle of
  83         the line of a caption.
  84         It is only used if <code>CaptionIsFixedAngle</code>
  85         is set to `TRUE`
  86     */
  87     [property] long CaptionAngle;
  88
  89     /** This property specifies the distance between the
  90         text area of the caption and the start of the line.
  91     */
  92     [property] long CaptionGap;
  93
  94     /** This property specifies the escape direction for the
  95         line of a caption.
  96
  97         @see CaptionEscapeDirection
  98     */
  99     [property] long CaptionEscapeDirection;
 100
 101     /** If this property is `TRUE`, the property <code>CaptionEscapeRelative</code>
 102         is used, else the property <code>CaptionEscapeAbsolute</code> is used.
 103     */
 104     [property] boolean CaptionIsEscapeRelative;
 105
 106     /** This property specifies the relative escape distance for
 107         the line of a caption.
 108     */
 109     [property] long CaptionEscapeRelative;
 110
 111     /** This property specifies the absolute escape distance for
 112         the line of a caption.
 113     */
 114     [property] long CaptionEscapeAbsolute;
 115
 116     /** This property specifies the length of the caption line.
 117     */
 118     [property] long CaptionLineLength;
 119
 120     /** If this property is `TRUE`, the application determines
 121         the best possible length for the caption line.
 122     */
 123     [property] boolean CaptionIsFitLineLength;
 124 };
 125
 126
 127 }; }; }; };
 128
 129 #endif
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */