offapi/com/sun/star/text/TextPageStyle.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: TextPageStyle.idl,v $
  10  * $Revision: 1.6 $
  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
  31 #ifndef __com_sun_star_text_TextPageStyle_idl__
  32 #define __com_sun_star_text_TextPageStyle_idl__
  33
  34 #ifndef __com_sun_star_util_Color_idl__
  35 #include <com/sun/star/util/Color.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_ShadowFormat_idl__
  39 #include <com/sun/star/table/ShadowFormat.idl>
  40 #endif
  41 #ifndef __com_sun_star_table_BorderLine_idl__
  42 #include <com/sun/star/table/BorderLine.idl>
  43 #endif
  44 #ifndef __com_sun_star_style_PageStyleLayout_idl__
  45 #include <com/sun/star/style/PageStyleLayout.idl>
  46 #endif
  47 #ifndef __com_sun_star_style_GraphicLocation_idl__
  48 #include <com/sun/star/style/GraphicLocation.idl>
  49 #endif
  50 #ifndef __com_sun_star_awt_Size_idl__
  51 #include <com/sun/star/awt/Size.idl>
  52 #endif
  53 #ifndef __com_sun_star_text_XText_idl__
  54 #include <com/sun/star/text/XText.idl>
  55 #endif
  56 #ifndef __com_sun_star_text_XTextColumns_idl__
  57 #include <com/sun/star/text/XTextColumns.idl>
  58 #endif
  59 #ifndef __com_sun_star_container_XNameContainer_idl__
  60 #include <com/sun/star/container/XNameContainer.idl>
  61 #endif
  62
  63 //=============================================================================
  64
  65 module com {  module sun {  module star {  module text {
  66
  67 //=============================================================================
  68
  69 /** represents a page style for a text document.
  70
  71     <p>This service extends the service
  72     <type scope="com::sun::star::style">PageStyle</type> with specific
  73     properties for text documents.</p>
  74  */
  75 published service TextPageStyle
  76 {
  77     //-------------------------------------------------------------------------
  78
  79     /** determins whether the register mode is active on that page.
  80       */
  81     [property] boolean RegisterModeActive;
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** contains the name of the paragraph style that is used as
  86         reference of the register mode.
  87       */
  88     [property] string RegisterParagraphStyle;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** contains the column settings of the page.
  93       */
  94     [property] com::sun::star::text::XTextColumns TextColumns;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** contains the interface to the text of the header.
  99
 100         @see com::sun::star::text::Text
 101       */
 102     [property] com::sun::star::text::XText HeaderText;
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** contains the interface to the text of the header of left pages.
 107
 108         @see com::sun::star::text::Text
 109       */
 110     [property] com::sun::star::text::XText HeaderTextLeft;
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** contains the interface to the text of the header of right pages.
 115
 116         @see com::sun::star::text::Text
 117       */
 118     [property] com::sun::star::text::XText HeaderTextRight;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** contains the interface to the text of the footer.
 123
 124         @see com::sun::star::text::Text
 125       */
 126     [property] com::sun::star::text::XText FooterText;
 127
 128     //-------------------------------------------------------------------------
 129
 130     /** contains the interface to the text of the footer of a left page.
 131
 132         @see com::sun::star::text::Text
 133       */
 134     [property] com::sun::star::text::XText FooterTextLeft;
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** contains the interface to the text of the footer of a right page.
 139
 140         @see com::sun::star::text::Text
 141       */
 142     [property] com::sun::star::text::XText FooterTextRight;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** contains the maximum height of the footnote area (in 1/100 mm).
 147
 148         <p>If set to zero, the height of the current page is used as limit.</p>
 149      */
 150     [property] long FootnoteHeight;
 151
 152     //-------------------------------------------------------------------------
 153
 154     /** contains the weight of the separator line between the text and
 155         the footnote area (in 1/100 mm).
 156       */
 157     [property] short FootnoteLineWeight;
 158
 159     //-------------------------------------------------------------------------
 160
 161     /** contains the color of the separator line between the text and
 162         the footnote area.
 163       */
 164     [property] com::sun::star::util::Color FootnoteLineColor;
 165
 166     //-------------------------------------------------------------------------
 167
 168     /** contains the relative width of the separator line between the
 169         text and the footnote area (in percent).
 170       */
 171     [property] byte FootnoteLineRelativeWidth;
 172
 173     //-------------------------------------------------------------------------
 174
 175     /** contains the adjustment of the separator line between the text
 176         and the footnote area.
 177
 178         @see com::sun::star::text::HorizontalAdjust
 179       */
 180     [property] short FootnoteLineAdjust;
 181
 182     //-------------------------------------------------------------------------
 183
 184     /** contains the distance between the text and the separator line
 185         between the text and the footnote area (in 1/100 mm).
 186       */
 187     [property] long FootnoteLineTextDistance;
 188
 189     //-------------------------------------------------------------------------
 190
 191     /** contains the distance between the footnote area and the separator
 192         line between the text and the footnote area (in 1/100 mm).
 193      */
 194     [property] long FootnoteLineDistance;
 195
 196 };
 197
 198 //=============================================================================
 199
 200 }; }; }; };
 201
 202 #endif
 203