offapi/com/sun/star/text/TextPageStyle.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 text {
  22
  23
  24 /** represents a page style for a text document.
  25
  26     <p>This service extends the service
  27     com::sun::star::style::PageStyle with specific
  28     properties for text documents.</p>
  29  */
  30 published service TextPageStyle
  31 {
  32
  33     /** determines whether the register mode is active on that page.
  34       */
  35     [property] boolean RegisterModeActive;
  36
  37
  38     /** contains the name of the paragraph style that is used as
  39         reference of the register mode.
  40       */
  41     [property] string RegisterParagraphStyle;
  42
  43
  44     /** contains the column settings of the page.
  45       */
  46     [property] com::sun::star::text::XTextColumns TextColumns;
  47
  48
  49     /** contains the interface to the text of the header.
  50
  51         @see com::sun::star::text::Text
  52       */
  53     [property] com::sun::star::text::XText HeaderText;
  54
  55
  56     /** contains the interface to the text of the header of left pages.
  57
  58         @see com::sun::star::text::Text
  59       */
  60     [property] com::sun::star::text::XText HeaderTextLeft;
  61
  62
  63     /** contains the interface to the text of the header of right pages.
  64
  65         @see com::sun::star::text::Text
  66       */
  67     [property] com::sun::star::text::XText HeaderTextRight;
  68
  69
  70     /** contains the interface to the text of the header of first pages.
  71
  72         @see com::sun::star::text::Text
  73
  74         @since LibreOffice 4.0
  75       */
  76     [optional, property] com::sun::star::text::XText HeaderTextFirst;
  77
  78
  79     /** contains the interface to the text of the footer.
  80
  81         @see com::sun::star::text::Text
  82       */
  83     [property] com::sun::star::text::XText FooterText;
  84
  85
  86     /** contains the interface to the text of the footer of a left page.
  87
  88         @see com::sun::star::text::Text
  89       */
  90     [property] com::sun::star::text::XText FooterTextLeft;
  91
  92
  93     /** contains the interface to the text of the footer of a right page.
  94
  95         @see com::sun::star::text::Text
  96       */
  97     [property] com::sun::star::text::XText FooterTextRight;
  98
  99
 100     /** contains the interface to the text of the footer of a first page.
 101
 102         @see com::sun::star::text::Text
 103
 104         @since LibreOffice 4.0
 105       */
 106     [optional, property] com::sun::star::text::XText FooterTextFirst;
 107
 108
 109     /** contains the maximum height of the footnote area (in 1/100 mm).
 110
 111         <p>If set to zero, the height of the current page is used as limit.</p>
 112      */
 113     [property] long FootnoteHeight;
 114
 115
 116     /** contains the weight of the separator line between the text and
 117         the footnote area (in 1/100 mm).
 118       */
 119     [property] short FootnoteLineWeight;
 120
 121
 122     /** contains the color of the separator line between the text and
 123         the footnote area.
 124       */
 125     [property] com::sun::star::util::Color FootnoteLineColor;
 126
 127
 128     /** contains the relative width of the separator line between the
 129         text and the footnote area (in percent).
 130       */
 131     [property] byte FootnoteLineRelativeWidth;
 132
 133
 134     /** contains the adjustment of the separator line between the text
 135         and the footnote area.
 136
 137         @see com::sun::star::text::HorizontalAdjust
 138       */
 139     [property] short FootnoteLineAdjust;
 140
 141
 142     /** contains the distance between the text and the separator line
 143         between the text and the footnote area (in 1/100 mm).
 144       */
 145     [property] long FootnoteLineTextDistance;
 146
 147
 148     /** contains the distance between the footnote area and the separator
 149         line between the text and the footnote area (in 1/100 mm).
 150      */
 151     [property] long FootnoteLineDistance;
 152
 153 };
 154
 155
 156 }; }; }; };
 157
 158 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */