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
  20
  21  module com {  module sun {  module star {  module drawing {
  22
  23
  24 /** The CaptionShape represents a rectangular drawing shape
  25     with an additional set of lines. It can be used as a description for
  26     a fixed point inside a drawing.
  27  */
  28 published service CaptionShape
  29 {
  30     /** the position and size is only used for the
  31         caption area
  32     */
  33     service com::sun::star::drawing::Shape;
  34
  35     service com::sun::star::drawing::FillProperties;
  36
  37     service com::sun::star::drawing::LineProperties;
  38
  39     service com::sun::star::drawing::ShadowProperties;
  40
  41     service com::sun::star::drawing::Text;
  42
  43     service com::sun::star::drawing::RotationDescriptor;
  44
  45     /** This is the radius of the caption area corners.
  46      */
  47     [property] long CornerRadius;
  48
  49     /** The caption point property specify the position of
  50         the point that is captioned. A set of lines are
  51         rendered from the caption area.
  52     */
  53     [property] com::sun::star::awt::Point CaptionPoint;
  54
  55     /** This property specifies the geometry of the line of a caption.
  56
  57         @see CaptionType
  58     */
  59     [property] short CaptionType;
  60
  61     /** This property specifies if the escape angle of
  62         the line of a caption is fixed or free. If this
  63         is set to `FALSE`, the application can choose
  64         the best possible angle. If not, the value in
  65         <code>CaptionAngle</code> is used.
  66     */
  67     [property] boolean CaptionIsFixedAngle;
  68
  69     /** This property specifies the escape angle of
  70         the line of a caption.
  71         It is only used if <code>CaptionIsFixedAngle</code>
  72         is set to `TRUE`
  73     */
  74     [property] long CaptionAngle;
  75
  76     /** This property specifies the distance between the
  77         text area of the caption and the start of the line.
  78     */
  79     [property] long CaptionGap;
  80
  81     /** This property specifies the escape direction for the
  82         line of a caption.
  83
  84         @see CaptionEscapeDirection
  85     */
  86     [property] long CaptionEscapeDirection;
  87
  88     /** If this property is `TRUE`, the property <code>CaptionEscapeRelative</code>
  89         is used, else the property <code>CaptionEscapeAbsolute</code> is used.
  90     */
  91     [property] boolean CaptionIsEscapeRelative;
  92
  93     /** This property specifies the relative escape distance for
  94         the line of a caption.
  95     */
  96     [property] long CaptionEscapeRelative;
  97
  98     /** This property specifies the absolute escape distance for
  99         the line of a caption.
 100     */
 101     [property] long CaptionEscapeAbsolute;
 102
 103     /** This property specifies the length of the caption line.
 104     */
 105     [property] long CaptionLineLength;
 106
 107     /** If this property is `TRUE`, the application determines
 108         the best possible length for the caption line.
 109     */
 110     [property] boolean CaptionIsFitLineLength;
 111 };
 112
 113
 114 }; }; }; };
 115
 116 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */