offapi/com/sun/star/style/PageProperties.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 pages.
  23  */
  24 published service PageProperties
  25 {
  26     /** contains the background color of the page.
  27      */
  28     [property] com::sun::star::util::Color BackColor;
  29
  30     /** contains the URL of the background graphic.
  31
  32         @deprecated as of LibreOffice 6.1 - use BackGraphic instead
  33
  34         Note the new behaviour since it this was deprecated:
  35         This property can only be set and only external URLs are
  36         supported (no more vnd.sun.star.GraphicObject scheme). When an
  37         URL is set, then it will load the graphic and set the BackGraphic
  38         property.
  39      */
  40     [property] string BackGraphicURL;
  41
  42     /** contains the filter name of the background graphic.
  43      */
  44     [property] string BackGraphicFilter;
  45
  46     /** determines the location of the background graphic.
  47      */
  48     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
  49
  50     /** determines if the background color is transparent.
  51
  52         <p>If this property is set to `TRUE`,
  53         PageStyle::BackColor will not be used.</p>
  54      */
  55     [property] boolean BackTransparent;
  56
  57     /** determines the left margin of the page.
  58      */
  59     [property] long LeftMargin;
  60
  61     /** determines the right margin of the page.
  62      */
  63     [property] long RightMargin;
  64
  65     /** determines the top margin of the page.
  66      */
  67     [property] long TopMargin;
  68
  69     /** determines the bottom margin of the page.
  70      */
  71     [property] long BottomMargin;
  72
  73     /** determines the style of the left border line of the page.
  74      */
  75     [property] com::sun::star::table::BorderLine LeftBorder;
  76
  77     /** determines the style of the right border line of the page.
  78      */
  79     [property] com::sun::star::table::BorderLine RightBorder;
  80
  81     /** determines the style of the top border line of the page.
  82      */
  83     [property] com::sun::star::table::BorderLine TopBorder;
  84
  85     /** determines the style of the bottom border line of the page.
  86      */
  87     [property] com::sun::star::table::BorderLine BottomBorder;
  88
  89     /** determines the left border distance of the page.
  90      */
  91     [property] long LeftBorderDistance;
  92
  93     /** determines the right border distance of the page.
  94      */
  95     [property] long RightBorderDistance;
  96
  97     /** determines the top border distance of the page.
  98      */
  99     [property] long TopBorderDistance;
 100
 101     /** determines the bottom border distance of the page.
 102      */
 103     [property] long BottomBorderDistance;
 104
 105     /** determines the shadow of the page.
 106      */
 107     [property] com::sun::star::table::ShadowFormat ShadowFormat;
 108
 109     /** determines if the page format is landscape.
 110      */
 111     [property] boolean IsLandscape;
 112
 113     /** determines the default numbering type for this page.
 114      */
 115     [property] short NumberingType;
 116
 117     /** determines the layout of the page.
 118      */
 119     [property] com::sun::star::style::PageStyleLayout PageStyleLayout;
 120
 121     /** contains the name of a paper tray of the selected printer.
 122      */
 123     [property] string PrinterPaperTray;
 124
 125     /** determines if the register mode is active on that page.
 126      */
 127     [optional, property] boolean RegisterModeActive;
 128
 129     /** contains the name of the paragraph style that is used as reference of the register mode.
 130      */
 131     [optional, property] string RegisterParagraphStyle;
 132
 133     /** contains the paper size of the page.
 134      */
 135     [property] com::sun::star::awt::Size Size;
 136
 137     /** contains the width of the page.
 138      */
 139     [property] long Width;
 140
 141     /** contains the height of the page.
 142      */
 143     [property] long Height;
 144
 145     /** contains the column settings of the page.
 146      */
 147     [optional , property] com::sun::star::text::XTextColumns TextColumns;
 148
 149     /** contains user defined attributes.
 150
 151         @see com::sun::star::xml::AttributeContainer
 152      */
 153     [property] com::sun::star::container::XNameContainer UserDefinedAttributes;
 154
 155     /** contains the color of the background of the header.
 156      */
 157     [property, maybevoid] com::sun::star::util::Color HeaderBackColor;
 158
 159     /** contains the URL of the background graphic of the header.
 160
 161         @deprecated as of LibreOffice 6.1 - use HeaderBackGraphic instead
 162
 163         Note the new behaviour since it this was deprecated:
 164         This property can only be set and only external URLs are
 165         supported (no more vnd.sun.star.GraphicObject scheme). When an
 166         URL is set, then it will load the graphic and set the HeaderBackGraphic
 167         property.
 168      */
 169     [property, maybevoid] string HeaderBackGraphicURL;
 170
 171     /** contains the filter name of the background graphic of the header.
 172      */
 173     [property, maybevoid] string HeaderBackGraphicFilter;
 174
 175     /** determines the location of the background graphic of the header.
 176      */
 177     [property, maybevoid] com::sun::star::style::GraphicLocation HeaderBackGraphicLocation;
 178
 179     /** contains the left margin of the header.
 180      */
 181     [property, maybevoid] long HeaderLeftMargin;
 182
 183     /** contains the right margin of the header.
 184      */
 185     [property, maybevoid] long HeaderRightMargin;
 186
 187     /** determines if the background color of the header is transparent.
 188
 189         <p>If this property is set to `TRUE`,
 190         PageStyle::HeaderBackColor will not be used.</p>
 191      */
 192     [property, maybevoid] boolean HeaderBackTransparent;
 193
 194     /** determines the style of the left border line of the header.
 195      */
 196     [property, maybevoid] com::sun::star::table::BorderLine HeaderLeftBorder;
 197
 198     /** determines the style of the right border line of the header.
 199      */
 200     [property, maybevoid] com::sun::star::table::BorderLine HeaderRightBorder;
 201
 202     /** determines the style of the top border line of the header.
 203      */
 204     [property, maybevoid] com::sun::star::table::BorderLine HeaderTopBorder;
 205
 206     /** determines the style of the bottom border line of the header.
 207      */
 208     [property, maybevoid] com::sun::star::table::BorderLine HeaderBottomBorder;
 209
 210     /** determines the left border distance of the header.
 211      */
 212     [property, maybevoid] long HeaderLeftBorderDistance;
 213
 214     /** determines the right border distance of the header.
 215      */
 216     [property, maybevoid] long HeaderRightBorderDistance;
 217
 218     /** determines the top border distance of the header.
 219      */
 220     [property, maybevoid] long HeaderTopBorderDistance;
 221
 222     /** determines the bottom border distance of the header.
 223      */
 224     [property, maybevoid] long HeaderBottomBorderDistance;
 225
 226     /** determines the shadow of the header.
 227      */
 228     [property, maybevoid] com::sun::star::table::ShadowFormat HeaderShadowFormat;
 229
 230     /** determines the distance between the header and the body text area.
 231      */
 232     [property, maybevoid] long HeaderBodyDistance;
 233
 234     /** determines if the header content on left and right pages is the same.
 235      */
 236     [property, maybevoid] boolean HeaderIsShared;
 237
 238     /** determines if the header/footer content on the first page and remaining pages is the same.
 239
 240         @since LibreOffice 4.0
 241      */
 242     [optional, property, maybevoid] boolean FirstIsShared;
 243
 244     /** contains the height of the header.
 245      */
 246     [property, maybevoid] long HeaderHeight;
 247
 248     /** determines if the height of the header depends on the content.
 249      */
 250     [property, maybevoid] boolean HeaderIsDynamicHeight;
 251
 252     /** determines if a header is used on the page.
 253      */
 254     [property] boolean HeaderIsOn;
 255
 256     /** contains the interface to the text of the header.
 257      */
 258     [optional, property, maybevoid] com::sun::star::text::XText HeaderText;
 259
 260     /** contains the interface to the text of the header of left pages.
 261      */
 262     [optional, property, maybevoid] com::sun::star::text::XText HeaderTextLeft;
 263
 264     /** contains the interface to the text of the header of right pages.
 265      */
 266     [optional, property, maybevoid] com::sun::star::text::XText HeaderTextRight;
 267
 268     /** contains the color of the background of the footer.
 269      */
 270     [property, maybevoid] com::sun::star::util::Color FooterBackColor;
 271
 272     /** contains the URL of the background graphic in the footer.
 273
 274         @deprecated as of LibreOffice 6.1 - use FooterBackGraphic
 275
 276         Note the new behaviour since it this was deprecated:
 277         This property can only be set and only external URLs are
 278         supported (no more vnd.sun.star.GraphicObject scheme). When an
 279         URL is set, then it will load the graphic and set the FooterBackGraphic
 280         property.
 281      */
 282     [property, maybevoid] string FooterBackGraphicURL;
 283
 284     /** contains the filter name of the background graphic in the footer.
 285      */
 286     [property, maybevoid] string FooterBackGraphicFilter;
 287
 288     /** determines the location of the background graphic in the footer.
 289      */
 290     [property, maybevoid] com::sun::star::style::GraphicLocation FooterBackGraphicLocation;
 291
 292     /** determines the left margin of the footer.
 293      */
 294     [property, maybevoid] long FooterLeftMargin;
 295
 296     /** determines the right margin of the footer.
 297      */
 298     [property, maybevoid] long FooterRightMargin;
 299
 300     /** determines if the background of the footer is transparent.
 301      */
 302     [property, maybevoid] boolean FooterBackTransparent;
 303
 304     /** contains the style of the left border line of the footer.
 305      */
 306     [property, maybevoid] com::sun::star::table::BorderLine FooterLeftBorder;
 307
 308     /** contains the style of the right border line of the footer.
 309      */
 310     [property, maybevoid] com::sun::star::table::BorderLine FooterRightBorder;
 311
 312     /** contains the style of the top border line of the footer.
 313      */
 314     [property, maybevoid] com::sun::star::table::BorderLine FooterTopBorder;
 315
 316     /** contains the style of the bottom border line of the footer.
 317      */
 318     [property, maybevoid] com::sun::star::table::BorderLine FooterBottomBorder;
 319
 320     /** contains the left border distance of the footer.
 321      */
 322     [property, maybevoid] long FooterLeftBorderDistance;
 323
 324     /** contains the right border distance of the footer.
 325      */
 326     [property, maybevoid] long FooterRightBorderDistance;
 327
 328     /** contains the top border distance of the footer.
 329      */
 330     [property, maybevoid] long FooterTopBorderDistance;
 331
 332     /** contains the bottom border distance of the footer.
 333      */
 334     [property, maybevoid] long FooterBottomBorderDistance;
 335
 336     /** determines the shadow of the footer.
 337      */
 338     [property, maybevoid] com::sun::star::table::ShadowFormat FooterShadowFormat;
 339
 340     /** determines the distance between the footer and the body text area.
 341      */
 342     [property, maybevoid] long FooterBodyDistance;
 343
 344     /** determines if the height of the footer depends on the content.
 345      */
 346     [property, maybevoid] boolean FooterIsDynamicHeight;
 347
 348     /** determines if the footer content on left and right pages is the same.
 349      */
 350     [property, maybevoid] boolean FooterIsShared;
 351
 352     /** determines the height of the footer.
 353      */
 354     [property, maybevoid] long FooterHeight;
 355
 356     /** determines if a footer is used on the page.
 357      */
 358     [property] boolean FooterIsOn;
 359
 360     /** contains the interface to the text of the footer.
 361      */
 362     [optional, property, maybevoid] com::sun::star::text::XText FooterText;
 363
 364     /** contains the interface to the text of the footer of a left page.
 365      */
 366     [optional, property, maybevoid] com::sun::star::text::XText FooterTextLeft;
 367
 368     /** contains the interface to the text of the footer of a right page.
 369      */
 370     [optional, property, maybevoid] com::sun::star::text::XText FooterTextRight;
 371
 372     /** contains the maximum height of the footnote area. If set to zero then the height
 373     of the current page is used as limit.
 374      */
 375     [optional,property] long FootnoteHeight;
 376
 377     /** contains the weight of the separator line between the text and the footnote area.
 378      */
 379     [optional,property] short FootnoteLineWeight;
 380
 381     /** contains the style of the separator line between the text and the footnote area.
 382
 383         @see com::sun::star::style::FootnoteLineStyle
 384             for the possible values.
 385      */
 386     [optional,property] short FootnoteLineStyle;
 387
 388     /** contains the color of the separator line between the text and the footnote area.
 389      */
 390     [optional,property] com::sun::star::util::Color FootnoteLineColor;
 391
 392     /** contains the relative width of the separator line between the text and the footnote area.
 393      */
 394     [optional,property] byte FootnoteLineRelativeWidth;
 395
 396     /** contains the adjustment of the separator line between the text and the footnote area.
 397          <p>com::sun::star::text::HorizontalAdjusts.</p>
 398      */
 399     [optional,property] short FootnoteLineAdjust;
 400
 401     /** contains the distance between the text and the separator line between the
 402      text and the footnote area.
 403      */
 404     [optional,property] long FootnoteLineTextDistance;
 405
 406     /** contains the distance between the footnote area and the separator line between
 407          the text and the footnote area.
 408      */
 409     [optional,property] long FootnoteLineDistance;
 410
 411     /** contains the writing direction, as represented by the
 412         com::sun::star::text::WritingMode2 constants */
 413     [optional,property] short WritingMode;
 414
 415     /** contains the mode of the text grid (none, lines, ...), as
 416         represented by com::sun::star::text::TextGridMode
 417         constants */
 418     [optional, property] short GridMode;
 419
 420     /** contains the display color of the text grid */
 421     [optional, property] com::sun::star::util::Color GridColor;
 422
 423     /** contains the number of lines in the text grid */
 424     [optional, property] short GridLines;
 425
 426     /** contains the height of the base text line inside the text grid */
 427     [optional, property] long GridBaseHeight;
 428
 429     /** contains the height of the ruby text line inside the text grid */
 430     [optional, property] long GridRubyHeight;
 431
 432     /** determines whether the text grid's ruby line is located below or
 433         above the base line */
 434     [optional, property] boolean GridRubyBelow;
 435
 436     /** determines whether the text grid lines are printed */
 437     [optional, property] boolean GridPrint;
 438
 439     /** determines whether the text grid lines are visible or not */
 440     [optional, property] boolean GridDisplay;
 441
 442     /** determines whether to use dynamic spacing in header or not. */
 443     [optional, property, maybevoid] boolean HeaderDynamicSpacing;
 444
 445     /** determines whether to use dynamic spacing in footer or not. */
 446     [optional, property, maybevoid] boolean FooterDynamicSpacing;
 447
 448     /** determines the distance of all borders of the page. */
 449     [property] long BorderDistance;
 450
 451     /** contains the distance of all borders of the footer. */
 452     [property, maybevoid] long FooterBorderDistance;
 453
 454     /** determines the distance of all borders of the header. */
 455     [property, maybevoid] long HeaderBorderDistance;
 456
 457     /** contains the graphic of the background.
 458
 459         @since LibreOffice 6.1
 460      */
 461     [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
 462
 463     /** contains the graphic of the background of the header.
 464
 465         @since LibreOffice 6.1
 466      */
 467     [optional, property, maybevoid] com::sun::star::graphic::XGraphic HeaderBackGraphic;
 468
 469     /** contains the graphic of the background of the footer.
 470
 471         @since LibreOffice 6.1
 472      */
 473     [optional, property, maybevoid] com::sun::star::graphic::XGraphic FooterBackGraphic;
 474
 475     /** determines the gutter margin of the page.
 476
 477         @since LibreOffice 7.2
 478      */
 479     [optional, property] long GutterMargin;
 480
 481     /** does the background cover the full page or only inside the
 482         margins?
 483
 484         @since LibreOffice 7.2
 485      */
 486     [optional, property] boolean BackgroundFullSize;
 487
 488     /** specifies that the page gutter shall be placed on the right side of the page.
 489
 490         @since LibreOffice 7.2
 491      */
 492     [optional, property] boolean RtlGutter;
 493
 494 };
 495
 496 }; }; }; };
 497
 498 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */