offapi/com/sun/star/drawing/TextProperties.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: TextProperties.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_TextProperties_idl__
  31 #define __com_sun_star_drawing_TextProperties_idl__
  32
  33 #ifndef __com_sun_star_container_XIndexReplace_idl__
  34 #include <com/sun/star/container/XIndexReplace.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_style_CharacterProperties_idl__
  38 #include <com/sun/star/style/CharacterProperties.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
  42 #include <com/sun/star/style/CharacterPropertiesAsian.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
  46 #include <com/sun/star/style/CharacterPropertiesComplex.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_style_ParagraphProperties_idl__
  50 #include <com/sun/star/style/ParagraphProperties.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_style_ParagraphPropertiesAsian_idl__
  54 #include <com/sun/star/style/ParagraphPropertiesAsian.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_style_ParagraphPropertiesComplex_idl__
  58 #include <com/sun/star/style/ParagraphPropertiesComplex.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_drawing_TextFitToSizeType_idl__
  62 #include <com/sun/star/drawing/TextFitToSizeType.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_drawing_TextAdjust_idl__
  66 #include <com/sun/star/drawing/TextAdjust.idl>
  67 #endif
  68
  69 #ifndef __com_sun_star_drawing_TextAnimationDirection_idl__
  70 #include <com/sun/star/drawing/TextAnimationDirection.idl>
  71 #endif
  72
  73 #ifndef __com_sun_star_drawing_TextAnimationKind_idl__
  74 #include <com/sun/star/drawing/TextAnimationKind.idl>
  75 #endif
  76
  77 #ifndef __com_sun_star_drawing_TextVerticalAdjust_idl__
  78 #include <com/sun/star/drawing/TextVerticalAdjust.idl>
  79 #endif
  80
  81 #ifndef __com_sun_star_drawing_TextHorizontalAdjust_idl__
  82 #include <com/sun/star/drawing/TextHorizontalAdjust.idl>
  83 #endif
  84
  85 #ifndef __com_sun_star_text_WritingMode_idl__
  86 #include <com/sun/star/text/WritingMode.idl>
  87 #endif
  88
  89 //=============================================================================
  90
  91  module com {  module sun {  module star {  module drawing {
  92
  93 //=============================================================================
  94
  95
  96 /** This is a set of properties to describe the style for rendering the
  97     text area inside a shape.
  98  */
  99 published service TextProperties
 100 {
 101     /** The properties in this service set default formats for text
 102         inside the <type>Shape</type>.
 103      */
 104     service com::sun::star::style::CharacterProperties;
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** The properties in this service set default formats for asian text
 109         inside the <type>Shape</type>.
 110      */
 111     [optional] service com::sun::star::style::CharacterPropertiesAsian;
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** The properties in this service set default formats for complex text
 116         inside the <type>Shape</type>.
 117      */
 118     [optional] service com::sun::star::style::CharacterPropertiesComplex;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** The properties in this service set default formats for text
 123         inside the <type>Shape</type>.
 124      */
 125     service com::sun::star::style::ParagraphProperties;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** The properties in this service set default formats for asian text
 130         inside the <type>Shape</type>.
 131      */
 132     [optional] service com::sun::star::style::ParagraphPropertiesAsian;
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** The properties in this service set default formats for complex text
 137         inside the <type>Shape</type>.
 138      */
 139     [optional] service com::sun::star::style::ParagraphPropertiesComplex;
 140     //-------------------------------------------------------------------------
 141
 142     /** If this is <TRUE/>, numbering is ON for the text of
 143         this <type>Shape</type>.
 144      */
 145     [optional, property] boolean IsNumbering;
 146
 147     //-------------------------------------------------------------------------
 148
 149     /** describes the numbering levels.
 150         <p>The different rules accessible with this
 151         <type scope="com::sun::star::container">XIndexReplace</type> interface
 152         are sequences of property values as described in the service
 153         <type scope="com::sun::star::style">NumberingRule</type>.</p>
 154      */
 155     [optional, property] com::sun::star::container::XIndexReplace NumberingRules;
 156
 157     //-------------------------------------------------------------------------
 158
 159     /** If this value is <TRUE/>, the height of the <type>Shape</type> is
 160         automatically expanded/shrunk when text is added to or removed from
 161         the <type>Shape</type>.
 162      */
 163     [property] boolean TextAutoGrowHeight;
 164
 165     //-------------------------------------------------------------------------
 166
 167     /** If this value is <TRUE/>, the width of the <type>Shape</type> is
 168         automatically expanded/shrunk when text is added to or removed from
 169         the <type>Shape</type>.
 170      */
 171     [property] boolean TextAutoGrowWidth;
 172
 173     //-------------------------------------------------------------------------
 174
 175     // DocMerge from xml: property com::sun::star::drawing::Text::TextContourFrame
 176     /** If this value is <TRUE/>, the left edge of every line of text is
 177         aligned with the left edge of this <type>Shape</type>.
 178      */
 179     [property] boolean TextContourFrame;
 180
 181     //-------------------------------------------------------------------------
 182
 183     /** With this set to <TRUE/>, the text inside of the <type>Shape</type>
 184         is stretched to fit into the <type>Shape</type>.
 185      */
 186     [property] com::sun::star::drawing::TextFitToSizeType TextFitToSize;
 187
 188     //-------------------------------------------------------------------------
 189
 190     /** adjusts the horizontal position of the text inside of
 191         the <type>Shape</type>.
 192      */
 193     [property] com::sun::star::drawing::TextHorizontalAdjust TextHorizontalAdjust;
 194
 195     //-------------------------------------------------------------------------
 196
 197     /** adjusts the vertical position of the text inside of
 198         the <type>Shape</type>.
 199      */
 200     [property] com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust;
 201
 202     //-------------------------------------------------------------------------
 203
 204     /** This is the distance from the left edge of the <type>Shape</type>
 205         to the left edge of the text.
 206         <p>This is only useful if <member>Text::TextHorizontalAdjust</member> is
 207         <const>BLOCK</const> or <const>STRETCH</const> or if
 208         <member>Text::TextFitSize</member> is <TRUE/>.</p>
 209      */
 210     [property] long TextLeftDistance;
 211
 212     //-------------------------------------------------------------------------
 213
 214     /** This is the distance from the right edge of the <type>Shape</type>
 215         to the right edge of the text.
 216
 217         <p>This is only useful if <member>Text::TextHorizontalAdjust</member> is
 218         <const>BLOCK</const> or <const>STRETCH</const>
 219         or if <member>Text::TextFitSize</member> is <TRUE/>.</p>
 220      */
 221     [property] long TextRightDistance;
 222
 223     //-------------------------------------------------------------------------
 224
 225     /** This is the distance from the upper edge of the <type>Shape</type> to
 226         the upper edge of the text.
 227
 228         <p>This is only useful if <member>Text::TextVerticalAdjust</member> is
 229         <const>BLOCK</const> or if <member>Text::TextFitSize</member> is
 230         <TRUE/>.</p>
 231      */
 232     [property] long TextUpperDistance;
 233
 234     //-------------------------------------------------------------------------
 235
 236     /** This is the distance from the lower edge of the <type>Shape</type> to the
 237         lower edge of the text.
 238
 239
 240
 241         <p>This is only useful if <member>Text::TextVerticalAdjust</member> is
 242         <const>BLOCK</const> or if <member>Text::TextFitSize</member> is
 243         <TRUE/>.</p>
 244      */
 245     [property] long TextLowerDistance;
 246
 247     //-------------------------------------------------------------------------
 248
 249     /** with this property you can set the maximum height for a shape with text.
 250         On edit, the auto grow feature will not grow the object heigher than
 251         the value of this property.
 252     */
 253     [property] long TextMaximumFrameHeight;
 254
 255     //-------------------------------------------------------------------------
 256
 257     /** with this property you can set the maximum width for a shape with text.
 258         On edit, the auto grow feature will not grow the objects wider than
 259         the value of this property.
 260     */
 261     [property] long TextMaximumFrameWidth;
 262
 263     //-------------------------------------------------------------------------
 264
 265     /** with this property you can set the minimum height for a shape with text.
 266         On edit, the auto grow feature will not shrink the objects height smaller
 267         than the value of this property.
 268     */
 269     [property] long TextMinimumFrameHeight;
 270
 271     //-------------------------------------------------------------------------
 272
 273     /** with this property you can set the minimum width for a shape with text.
 274         On edit, the auto grow feature will not shrink the object width smaller
 275         than the value of this property.
 276     */
 277     [property] long TextMinimumFrameWidth;
 278
 279     //-------------------------------------------------------------------------
 280
 281     /** This is the number of pixels the text is moved in each animation step.
 282      */
 283     [property] short TextAnimationAmount;
 284
 285     //-------------------------------------------------------------------------
 286
 287     /** This number defines how many times the text animation is repeated.
 288         <p>If this is set to zero, the repeat is endless.</p>
 289      */
 290     [property] short TextAnimationCount;
 291
 292     //-------------------------------------------------------------------------
 293
 294     /** This is the delay in thousandths of a second between each
 295         of the animation steps.
 296      */
 297     [property] short TextAnimationDelay;
 298
 299     //-------------------------------------------------------------------------
 300
 301     /** This enumeration defines the direction in which the text moves.
 302      */
 303     [property] com::sun::star::drawing::TextAnimationDirection TextAnimationDirection;
 304
 305     //-------------------------------------------------------------------------
 306
 307     /** This value defines the type of animation.
 308      */
 309     [property] com::sun::star::drawing::TextAnimationKind TextAnimationKind;
 310
 311     //-------------------------------------------------------------------------
 312
 313     /** If this value is <TRUE/>, the text is visible at the start of the
 314         animation.
 315      */
 316     [property] boolean TextAnimationStartInside;
 317
 318     //-------------------------------------------------------------------------
 319
 320     /** If this value is <TRUE/>, the text is visible at the end of the
 321         animation.
 322      */
 323     [property] boolean TextAnimationStopInside;
 324
 325     //-------------------------------------------------------------------------
 326
 327     /** This value selects the writing mode for the text.
 328      */
 329     [property] ::com::sun::star::text::WritingMode TextWritingMode;
 330 };
 331
 332 //=============================================================================
 333
 334 }; }; }; };
 335
 336 #endif
 337