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