offapi/com/sun/star/drawing/TextProperties.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
  25 /** This is a set of properties to describe the style for rendering the
  26     text area inside a shape.
  27  */
  28 published service TextProperties
  29 {
  30     /** The properties in this service set default formats for text
  31         inside the Shape.
  32      */
  33     service com::sun::star::style::CharacterProperties;
  34
  35
  36     /** The properties in this service set default formats for Asian text
  37         inside the Shape.
  38      */
  39     [optional] service com::sun::star::style::CharacterPropertiesAsian;
  40
  41
  42     /** The properties in this service set default formats for complex text
  43         inside the Shape.
  44      */
  45     [optional] service com::sun::star::style::CharacterPropertiesComplex;
  46
  47
  48     /** The properties in this service set default formats for text
  49         inside the Shape.
  50      */
  51     service com::sun::star::style::ParagraphProperties;
  52
  53
  54     /** The properties in this service set default formats for Asian text
  55         inside the Shape.
  56      */
  57     [optional] service com::sun::star::style::ParagraphPropertiesAsian;
  58
  59
  60     /** The properties in this service set default formats for complex text
  61         inside the Shape.
  62      */
  63     [optional] service com::sun::star::style::ParagraphPropertiesComplex;
  64
  65     /** If this is `TRUE`, numbering is ON for the text of
  66         this Shape.
  67      */
  68     [optional, property] boolean IsNumbering;
  69
  70
  71     /** describes the numbering levels.
  72         <p>The different rules accessible with this
  73         com::sun::star::container::XIndexReplace interface
  74         are sequences of property values as described in the service
  75         com::sun::star::style::NumberingRule.</p>
  76      */
  77     [optional, property] com::sun::star::container::XIndexReplace NumberingRules;
  78
  79
  80     /** If this value is `TRUE`, the height of the Shape is
  81         automatically expanded/shrunk when text is added to or removed from
  82         the Shape.
  83      */
  84     [property] boolean TextAutoGrowHeight;
  85
  86
  87     /** If this value is `TRUE`, the width of the Shape is
  88         automatically expanded/shrunk when text is added to or removed from
  89         the Shape.
  90      */
  91     [property] boolean TextAutoGrowWidth;
  92
  93     /** If this value is `TRUE`, the left edge of every line of text is
  94         aligned with the left edge of this Shape.
  95      */
  96     [property] boolean TextContourFrame;
  97
  98
  99     /** With this set to a value other than `NONE`, the text inside of
 100         the Shape is stretched or scaled to fit into the Shape.
 101      */
 102     [property] com::sun::star::drawing::TextFitToSizeType TextFitToSize;
 103
 104
 105     /** adjusts the horizontal position of the text inside of
 106         the Shape.
 107      */
 108     [property] com::sun::star::drawing::TextHorizontalAdjust TextHorizontalAdjust;
 109
 110
 111     /** adjusts the vertical position of the text inside of
 112         the Shape.
 113      */
 114     [property] com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust;
 115
 116
 117     /** This is the distance from the left edge of the Shape
 118         to the left edge of the text.
 119         <p>This is only useful if Text::TextHorizontalAdjust is
 120         BLOCK or STRETCH or if
 121         Text::TextFitSize is `TRUE`.</p>
 122      */
 123     [property] long TextLeftDistance;
 124
 125
 126     /** This is the distance from the right edge of the Shape
 127         to the right edge of the text.
 128
 129         <p>This is only useful if Text::TextHorizontalAdjust is
 130         BLOCK or STRETCH
 131         or if Text::TextFitSize is `TRUE`.</p>
 132      */
 133     [property] long TextRightDistance;
 134
 135
 136     /** This is the distance from the upper edge of the Shape to
 137         the upper edge of the text.
 138
 139         <p>This is only useful if Text::TextVerticalAdjust is
 140         BLOCK or if Text::TextFitSize is
 141         `TRUE`.</p>
 142      */
 143     [property] long TextUpperDistance;
 144
 145
 146     /** This is the distance from the lower edge of the Shape to the
 147         lower edge of the text.
 148
 149
 150
 151         <p>This is only useful if Text::TextVerticalAdjust is
 152         BLOCK or if Text::TextFitSize is
 153         `TRUE`.</p>
 154      */
 155     [property] long TextLowerDistance;
 156
 157
 158     /** with this property you can set the maximum height for a shape with text.
 159         On edit, the auto grow feature will not grow the object higher than
 160         the value of this property.
 161     */
 162     [property] long TextMaximumFrameHeight;
 163
 164
 165     /** with this property you can set the maximum width for a shape with text.
 166         On edit, the auto grow feature will not grow the objects wider than
 167         the value of this property.
 168     */
 169     [property] long TextMaximumFrameWidth;
 170
 171
 172     /** with this property you can set the minimum height for a shape with text.
 173         On edit, the auto grow feature will not shrink the objects height smaller
 174         than the value of this property.
 175     */
 176     [property] long TextMinimumFrameHeight;
 177
 178
 179     /** with this property you can set the minimum width for a shape with text.
 180         On edit, the auto grow feature will not shrink the object width smaller
 181         than the value of this property.
 182     */
 183     [property] long TextMinimumFrameWidth;
 184
 185
 186     /** This is the number of pixels the text is moved in each animation step.
 187      */
 188     [property] short TextAnimationAmount;
 189
 190
 191     /** This number defines how many times the text animation is repeated.
 192         <p>If this is set to zero, the repeat is endless.</p>
 193      */
 194     [property] short TextAnimationCount;
 195
 196
 197     /** This is the delay in thousandths of a second between each
 198         of the animation steps.
 199      */
 200     [property] short TextAnimationDelay;
 201
 202
 203     /** This enumeration defines the direction in which the text moves.
 204      */
 205     [property] com::sun::star::drawing::TextAnimationDirection TextAnimationDirection;
 206
 207
 208     /** This value defines the type of animation.
 209      */
 210     [property] com::sun::star::drawing::TextAnimationKind TextAnimationKind;
 211
 212
 213     /** If this value is `TRUE`, the text is visible at the start of the
 214         animation.
 215      */
 216     [property] boolean TextAnimationStartInside;
 217
 218
 219     /** If this value is `TRUE`, the text is visible at the end of the
 220         animation.
 221      */
 222     [property] boolean TextAnimationStopInside;
 223
 224
 225     /** This value selects the writing mode for the text.
 226      */
 227     [property] ::com::sun::star::text::WritingMode TextWritingMode;
 228
 229
 230     /** Column layout properties for the text.
 231
 232         @since LibreOffice 7.2
 233      */
 234     [optional, property] ::com::sun::star::text::XTextColumns TextColumns;
 235 };
 236
 237
 238 }; }; }; };
 239
 240 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */