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