offapi/com/sun/star/text/TextPageStyle.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_text_TextPageStyle_idl__
  29 #define __com_sun_star_text_TextPageStyle_idl__
  30
  31 #ifndef __com_sun_star_util_Color_idl__
  32 #include <com/sun/star/util/Color.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_table_ShadowFormat_idl__
  36 #include <com/sun/star/table/ShadowFormat.idl>
  37 #endif
  38 #ifndef __com_sun_star_table_BorderLine_idl__
  39 #include <com/sun/star/table/BorderLine.idl>
  40 #endif
  41 #ifndef __com_sun_star_style_PageStyleLayout_idl__
  42 #include <com/sun/star/style/PageStyleLayout.idl>
  43 #endif
  44 #ifndef __com_sun_star_style_GraphicLocation_idl__
  45 #include <com/sun/star/style/GraphicLocation.idl>
  46 #endif
  47 #ifndef __com_sun_star_awt_Size_idl__
  48 #include <com/sun/star/awt/Size.idl>
  49 #endif
  50 #ifndef __com_sun_star_text_XText_idl__
  51 #include <com/sun/star/text/XText.idl>
  52 #endif
  53 #ifndef __com_sun_star_text_XTextColumns_idl__
  54 #include <com/sun/star/text/XTextColumns.idl>
  55 #endif
  56 #ifndef __com_sun_star_container_XNameContainer_idl__
  57 #include <com/sun/star/container/XNameContainer.idl>
  58 #endif
  59
  60 //=============================================================================
  61
  62 module com {  module sun {  module star {  module text {
  63
  64 //=============================================================================
  65
  66 /** represents a page style for a text document.
  67
  68     <p>This service extends the service
  69     <type scope="com::sun::star::style">PageStyle</type> with specific
  70     properties for text documents.</p>
  71  */
  72 published service TextPageStyle
  73 {
  74     //-------------------------------------------------------------------------
  75
  76     /** determins whether the register mode is active on that page.
  77       */
  78     [property] boolean RegisterModeActive;
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** contains the name of the paragraph style that is used as
  83         reference of the register mode.
  84       */
  85     [property] string RegisterParagraphStyle;
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** contains the column settings of the page.
  90       */
  91     [property] com::sun::star::text::XTextColumns TextColumns;
  92
  93     //-------------------------------------------------------------------------
  94
  95     /** contains the interface to the text of the header.
  96
  97         @see com::sun::star::text::Text
  98       */
  99     [property] com::sun::star::text::XText HeaderText;
 100
 101     //-------------------------------------------------------------------------
 102
 103     /** contains the interface to the text of the header of left pages.
 104
 105         @see com::sun::star::text::Text
 106       */
 107     [property] com::sun::star::text::XText HeaderTextLeft;
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** contains the interface to the text of the header of right pages.
 112
 113         @see com::sun::star::text::Text
 114       */
 115     [property] com::sun::star::text::XText HeaderTextRight;
 116
 117     //-------------------------------------------------------------------------
 118
 119     /** contains the interface to the text of the footer.
 120
 121         @see com::sun::star::text::Text
 122       */
 123     [property] com::sun::star::text::XText FooterText;
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** contains the interface to the text of the footer of a left page.
 128
 129         @see com::sun::star::text::Text
 130       */
 131     [property] com::sun::star::text::XText FooterTextLeft;
 132
 133     //-------------------------------------------------------------------------
 134
 135     /** contains the interface to the text of the footer of a right page.
 136
 137         @see com::sun::star::text::Text
 138       */
 139     [property] com::sun::star::text::XText FooterTextRight;
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** contains the maximum height of the footnote area (in 1/100 mm).
 144
 145         <p>If set to zero, the height of the current page is used as limit.</p>
 146      */
 147     [property] long FootnoteHeight;
 148
 149     //-------------------------------------------------------------------------
 150
 151     /** contains the weight of the separator line between the text and
 152         the footnote area (in 1/100 mm).
 153       */
 154     [property] short FootnoteLineWeight;
 155
 156     //-------------------------------------------------------------------------
 157
 158     /** contains the color of the separator line between the text and
 159         the footnote area.
 160       */
 161     [property] com::sun::star::util::Color FootnoteLineColor;
 162
 163     //-------------------------------------------------------------------------
 164
 165     /** contains the relative width of the separator line between the
 166         text and the footnote area (in percent).
 167       */
 168     [property] byte FootnoteLineRelativeWidth;
 169
 170     //-------------------------------------------------------------------------
 171
 172     /** contains the adjustment of the separator line between the text
 173         and the footnote area.
 174
 175         @see com::sun::star::text::HorizontalAdjust
 176       */
 177     [property] short FootnoteLineAdjust;
 178
 179     //-------------------------------------------------------------------------
 180
 181     /** contains the distance between the text and the separator line
 182         between the text and the footnote area (in 1/100 mm).
 183       */
 184     [property] long FootnoteLineTextDistance;
 185
 186     //-------------------------------------------------------------------------
 187
 188     /** contains the distance between the footnote area and the separator
 189         line between the text and the footnote area (in 1/100 mm).
 190      */
 191     [property] long FootnoteLineDistance;
 192
 193 };
 194
 195 //=============================================================================
 196
 197 }; }; }; };
 198
 199 #endif
 200