offapi/com/sun/star/style/ParagraphProperties.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 module com {  module sun {  module star {  module style {
  21
  22 /** describes the style of paragraphs.
  23  */
  24 published service ParagraphProperties
  25 {
  26
  27     /** determines the adjustment of a paragraph.
  28      */
  29     [property] com::sun::star::style::ParagraphAdjust ParaAdjust;
  30
  31
  32     /** contains the type of the line spacing of a paragraph.
  33      */
  34     [optional, property] com::sun::star::style::LineSpacing ParaLineSpacing;
  35
  36
  37     /** contains the paragraph background color.
  38      */
  39     [optional, property] com::sun::star::util::Color ParaBackColor;
  40
  41
  42     /** This value is `TRUE` if the paragraph background color
  43         is set to transparent.
  44      */
  45     [optional, property] boolean ParaBackTransparent;
  46
  47
  48     /** contains the value of a link for the background graphic of a paragraph.
  49
  50         @deprecated as of LibreOffice 6.1 - use ParaBackGraphic instead
  51
  52         Note the new behaviour since it this was deprecated:
  53         This property can only be set and only external URLs are
  54         supported (no more vnd.sun.star.GraphicObject scheme). When an
  55         URL is set, then it will load the graphic and set the ParaBackGraphic
  56         property.
  57      */
  58     [optional, property] string ParaBackGraphicURL;
  59
  60     /** contains the name of the graphic filter for the background graphic of a paragraph.
  61      */
  62     [optional, property] string ParaBackGraphicFilter;
  63
  64
  65     /** contains the value for the position of a background graphic.
  66
  67         @see com::sun::star::style::GraphicLocation
  68      */
  69     [optional, property] com::sun::star::style::GraphicLocation ParaBackGraphicLocation;
  70
  71
  72     /** determines the adjustment of the last line.
  73         <p>It is only valid if ParagraphProperties::ParaAdjust
  74         is set to ParagraphAdjust::BLOCK.</p>
  75      */
  76     [property] short ParaLastLineAdjust;
  77
  78
  79     /** determines if single words are stretched.
  80
  81         <p>It is only valid if ParagraphProperties::ParaAdjust and
  82         ParagraphProperties::ParaLastLineAdjust are also valid.</p>
  83      */
  84     [optional, property] boolean ParaExpandSingleWord;
  85
  86
  87     /** determines the left margin of the paragraph in 100th mm.
  88      */
  89     [property] long ParaLeftMargin;
  90
  91
  92     /** determines the right margin of the paragraph in 100th mm.
  93      */
  94     [property] long ParaRightMargin;
  95
  96
  97     /** determines the top margin of the paragraph in 100th mm.
  98
  99         <p>The distance between two paragraphs is specified by:</p>
 100         <ul>
 101         <li>either the bottom margin of the previous paragraph.</li>
 102         <li>or the top margin of the following paragraph.</li>
 103         </ul>
 104         The greater one is chosen.
 105      */
 106     [property] long ParaTopMargin;
 107
 108
 109     /** determines the bottom margin of the paragraph in 100th mm.
 110
 111         <p>The distance between two paragraphs is specified by:</p>
 112         <ul>
 113         <li>either the bottom margin of the previous paragraph
 114         </li>
 115         <li>or the top margin of the following paragraph.
 116         </li>
 117         </ul>
 118         The greater one is chosen.
 119      */
 120     [property] long ParaBottomMargin;
 121
 122     /** determines if contextual spacing is used.
 123
 124         @since LibreOffice 3.6
 125
 126         <p>If true, the top and bottom margins of the paragraph should not be
 127         applied when the previous and next paragraphs have the same style.</p>
 128      */
 129     [optional, property] boolean ParaContextMargin;
 130
 131     /** Grab bag of paragraph properties, used as a string-any map for interim interop purposes.
 132
 133         @since LibreOffice 4.2
 134
 135         <p>This property is intentionally not handled by the ODF filter. Any
 136         member that should be handled there should be first moved out from this grab
 137         bag to a separate property.</p>
 138     */
 139     [optional, property] sequence<com::sun::star::beans::PropertyValue> ParaInteropGrabBag;
 140
 141     /** determines if the paragraph is included in the
 142         line numbering.
 143      */
 144     [optional, property] boolean ParaLineNumberCount;
 145
 146
 147     /** contains the start value for the line numbering.
 148      */
 149     [optional, property] long ParaLineNumberStartValue;
 150
 151
 152     /** If this property is set, it creates a page break before the
 153         paragraph it belongs to and assigns the value as the name
 154         of the new page style sheet to use.
 155      */
 156     [optional, property] string PageDescName;
 157
 158
 159     /** If a page break property is set at a paragraph, this property contains the new value for the page number.
 160      */
 161     [optional, property] short PageNumberOffset;
 162
 163
 164     /** determines if the register mode is applied to a
 165         paragraph.
 166
 167
 168
 169         <p>Remark: Register mode is only used if the register
 170         mode property of the page style is switched on.</p>
 171      */
 172     [optional, property] boolean ParaRegisterModeActive;
 173
 174
 175     /** specifies the positions and kinds of the tab stops within this
 176                 paragraph.
 177      */
 178     [optional, property] sequence<com::sun::star::style::TabStop> ParaTabStops;
 179
 180
 181     /** contains the name of the current paragraph style.
 182      */
 183     [optional, property] string ParaStyleName;
 184
 185
 186         /** contains the name of the current page style.
 187          */
 188         [optional, property, maybevoid, readonly] string PageStyleName;
 189
 190
 191     /** specifies whether the first characters of the
 192         paragraph are displayed in capital letters and how they are
 193         formatted.
 194      */
 195     [optional, property] com::sun::star::style::DropCapFormat DropCapFormat;
 196
 197
 198     /** specifies if the property <var>DropCapFormat</var>
 199         is applied to the whole first word.
 200      */
 201     [optional, property] boolean DropCapWholeWord;
 202
 203
 204     /** Setting this property to `TRUE` prevents page or column
 205         breaks between this and the following paragraph.
 206
 207
 208         <p>This feature is useful for preventing title paragraphs to be
 209         the last line on a page or column.</p>
 210      */
 211     [optional, property] boolean ParaKeepTogether;
 212
 213
 214     /** Setting this property to `FALSE` prevents the paragraph from
 215         getting split into two pages or columns.
 216      */
 217     [optional, property] boolean ParaSplit;
 218
 219
 220     /** specifies the numbering level of the    paragraph.
 221      */
 222     [optional, property] short NumberingLevel;
 223
 224     /** contains the numbering rules applied to this paragraph.
 225      */
 226         [optional, property] com::sun::star::container::XIndexReplace NumberingRules;
 227
 228
 229     /** specifies the start value for numbering if a new numbering starts at this paragraph.
 230      */
 231     [optional, property] short NumberingStartValue;
 232
 233     /** determines if the numbering rules restart, counting at the current paragraph.
 234      */
 235     [optional, property] boolean ParaIsNumberingRestart;
 236
 237     /** specifies the name of the style for the numbering.
 238
 239
 240         <p>The name must be one of the names which are available via
 241         XStyleFamiliesSupplier.</p>
 242      */
 243     [optional, property] string NumberingStyleName;
 244
 245     /** specifies the minimum number of lines of the paragraph that have
 246         to be at bottom of a page if the paragraph is spread over more than
 247         one page.
 248      */
 249     [optional, property] byte ParaOrphans;
 250
 251     /** specifies the minimum number of lines of the paragraph that have
 252         to be at top of a page if the paragraph is spread over more than
 253         one page.
 254      */
 255     [optional, property] byte ParaWidows;
 256     /** determines the type, color, and size of the shadow.
 257      @see com::sun::star::table::ShadowFormat
 258      */
 259     [optional, property] com::sun::star::table::ShadowFormat ParaShadowFormat;
 260     /** contains the left border of the object.
 261      */
 262         [property, optional] com::sun::star::table::BorderLine LeftBorder;
 263
 264     /** contains the right border of the object.
 265      */
 266         [property, optional] com::sun::star::table::BorderLine RightBorder;
 267
 268     /** contains the top border of the object.
 269      */
 270         [property, optional] com::sun::star::table::BorderLine TopBorder;
 271
 272     /** contains the bottom border of the object.
 273      */
 274         [property, optional] com::sun::star::table::BorderLine BottomBorder;
 275
 276     /** contains the distance from the border to the object.
 277      */
 278         [property, optional] long BorderDistance;
 279
 280     /** contains the distance from the left border to the object.
 281      */
 282         [property, optional] long LeftBorderDistance;
 283
 284     /** contains the distance from the right border to the object.
 285      */
 286         [property, optional] long RightBorderDistance;
 287
 288     /** contains the distance from the top border to the object.
 289      */
 290         [property, optional] long TopBorderDistance;
 291
 292     /** contains the distance from the bottom border to the object.
 293      */
 294         [property, optional] long BottomBorderDistance;
 295
 296         /** determines the type of break that is applied at the beginning of the table.
 297             @see com::sun::star::style::BreakType
 298          */
 299         [optional, property] com::sun::star::style::BreakType BreakType;
 300
 301         /** specifies the character style name for drop caps.
 302          */
 303         [optional, property] string DropCapCharStyleName;
 304
 305         /** specifies the indent for the first line.
 306          */
 307         [optional, property] long ParaFirstLineIndent;
 308
 309         /** determines if the first line should be indented automatically.
 310          */
 311         [optional, property] boolean ParaIsAutoFirstLineIndent;
 312
 313         /** specifies if automatic hyphenation is applied.
 314          */
 315         [property] boolean ParaIsHyphenation;
 316
 317         /** specifies the maximum number of consecutive hyphens.
 318          */
 319         [optional, property] short ParaHyphenationMaxHyphens;
 320
 321         /** specifies the minimum number of characters to remain before the
 322             hyphen character (when hyphenation is applied).
 323             @note Confusingly it is named Max but specifies a minimum.
 324          */
 325         [optional, property] short ParaHyphenationMaxLeadingChars;
 326
 327         /** specifies the minimum number of characters to remain after the
 328             hyphen character (when hyphenation is applied).
 329             @note Confusingly it is named Max but specifies a minimum.
 330          */
 331         [optional, property] short ParaHyphenationMaxTrailingChars;
 332
 333         /** specifies the vertical alignment of a paragraph.
 334
 335             @see com::sun::star::text::ParagraphVertAlign
 336          */
 337         [optional, property] short ParaVertAlignment;
 338
 339         /** this property stores xml attributes.
 340             They will be saved to and restored from automatic styles inside xml files.
 341
 342             @see com::sun::star::xml::AttributeContainer
 343          */
 344         [optional, property] com::sun::star::container::XNameContainer ParaUserDefinedAttributes;
 345
 346         /** returns `FALSE` if the paragraph is part of a numbering, but has no
 347             numbering label.
 348
 349             <p>A paragraph is part of a numbering, if a style for a numbering is
 350             set - see NumberingStyleName.</p>
 351             <p>If the paragraph is not part of a numbering the property is void.</p>
 352          */
 353         [optional, property, maybevoid] boolean NumberingIsNumber;
 354
 355         /** the property determines if borders set at a paragraph are merged with the
 356          next paragraph.
 357          <p>Borders are only merged if they are identical.</p>
 358          */
 359         [optional, property, maybevoid] boolean ParaIsConnectBorder;
 360
 361         /** specifies the id of the list to which the paragraph belongs
 362
 363          */
 364         [optional, property] string ListId;
 365
 366         /** specifies the outline level to which the paragraph belongs
 367
 368             @since OOo 3.1
 369
 370             <p>Value 0 indicates that the paragraph belongs to the body text.</p>
 371             <p>Values [1..10] indicates that the paragraph belongs to the corresponding outline level.</p>
 372          */
 373         [optional, property] short OutlineLevel;
 374
 375         /** contains the graphic for the background of a paragraph.
 376
 377             @since LibreOffice 6.1
 378          */
 379         [optional, property] com::sun::star::graphic::XGraphic ParaBackGraphic;
 380
 381         /** specifies that a child node of a parent node that is not counted
 382             is continuing the numbering of parent's previous node's sub tree.
 383
 384             @since OOo 3.0.1
 385
 386             @note misspelling retained for compatibility
 387          */
 388         [optional, property, readonly] boolean ContinueingPreviousSubTree;
 389
 390         /** allows reading the generated numbering list label.
 391
 392             @since OOo 3.0.1
 393          */
 394         [optional, property, readonly] string ListLabelString;
 395
 396         /** Specifies whether words written in CAPS will be hyphenated.
 397             Setting to `true` will disable hyphenation of words written in CAPS for this paragraph.
 398
 399             @since LibreOffice 6.4
 400          */
 401         [optional, property] boolean ParaHyphenationNoCaps;
 402
 403         /** Specifies whether last word of paragraph will be hyphenated.
 404             Setting to `true` will disable hyphenation of last word for this paragraph.
 405
 406             @since LibreOffice 7.4
 407          */
 408         [optional, property] boolean ParaHyphenationNoLastWord;
 409
 410         /** specifies the minimum word length in characters, when hyphenation is applied.
 411
 412             @since LibreOffice 7.4
 413          */
 414         [optional, property] short ParaHyphenationMinWordLength;
 415
 416         /** specifies the hyphenation zone, i.e. allowed extra white space
 417             in the line before applying hyphenation.
 418
 419             @since LibreOffice 7.4
 420          */
 421         [optional, property] long ParaHyphenationZone;
 422
 423         /** contains a paragraph identifier within the actual text,
 424             which also shows the position of the paragraph relative to the
 425             other paragraphs of the same text, i.e. a paragraph with lower
 426             identifier is there before the other ones with greater values.
 427             This property depends on implementation details and is considered experimental.
 428             @since LibreOffice 7.6
 429          */
 430         [optional, property, readonly] long SortedTextId;
 431
 432         /** This value is `TRUE` if both parts of a hyphenated word shall lie
 433             within a single spread, page, or column. The default type is column.
 434
 435             @see ParaHyphenationKeepType
 436
 437             @since LibreOffice 24.8
 438          */
 439         [optional, property] boolean ParaHyphenationKeep;
 440
 441         /** Specifies how last line on a page or on other regions is hyphenated.
 442
 443             @see ParaHyphenationKeep
 444
 445             @see com::sun::star::text::ParagraphHyphenationKeepType
 446
 447             @since LibreOffice 24.8
 448          */
 449         [optional, property] long ParaHyphenationKeepType;
 450
 451         /** specifies the minimum number of characters of the compound word part
 452             to remain before the hyphen character (when hyphenation is applied).
 453
 454             @since LibreOffice 24.8
 455          */
 456         [optional, property] short ParaHyphenationCompoundMinLeadingChars;
 457 };
 458
 459
 460 }; }; }; };
 461
 462 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */