1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_text_TextPageStyle_idl__ 25#define __com_sun_star_text_TextPageStyle_idl__ 26 27#ifndef __com_sun_star_util_Color_idl__ 28#include <com/sun/star/util/Color.idl> 29#endif 30 31#ifndef __com_sun_star_table_ShadowFormat_idl__ 32#include <com/sun/star/table/ShadowFormat.idl> 33#endif 34#ifndef __com_sun_star_table_BorderLine_idl__ 35#include <com/sun/star/table/BorderLine.idl> 36#endif 37#ifndef __com_sun_star_style_PageStyleLayout_idl__ 38#include <com/sun/star/style/PageStyleLayout.idl> 39#endif 40#ifndef __com_sun_star_style_GraphicLocation_idl__ 41#include <com/sun/star/style/GraphicLocation.idl> 42#endif 43#ifndef __com_sun_star_awt_Size_idl__ 44#include <com/sun/star/awt/Size.idl> 45#endif 46#ifndef __com_sun_star_text_XText_idl__ 47#include <com/sun/star/text/XText.idl> 48#endif 49#ifndef __com_sun_star_text_XTextColumns_idl__ 50#include <com/sun/star/text/XTextColumns.idl> 51#endif 52#ifndef __com_sun_star_container_XNameContainer_idl__ 53#include <com/sun/star/container/XNameContainer.idl> 54#endif 55 56//============================================================================= 57 58module com { module sun { module star { module text { 59 60//============================================================================= 61 62/** represents a page style for a text document. 63 64 <p>This service extends the service 65 <type scope="com::sun::star::style">PageStyle</type> with specific 66 properties for text documents.</p> 67 */ 68published service TextPageStyle 69{ 70 //------------------------------------------------------------------------- 71 72 /** determins whether the register mode is active on that page. 73 */ 74 [property] boolean RegisterModeActive; 75 76 //------------------------------------------------------------------------- 77 78 /** contains the name of the paragraph style that is used as 79 reference of the register mode. 80 */ 81 [property] string RegisterParagraphStyle; 82 83 //------------------------------------------------------------------------- 84 85 /** contains the column settings of the page. 86 */ 87 [property] com::sun::star::text::XTextColumns TextColumns; 88 89 //------------------------------------------------------------------------- 90 91 /** contains the interface to the text of the header. 92 93 @see com::sun::star::text::Text 94 */ 95 [property] com::sun::star::text::XText HeaderText; 96 97 //------------------------------------------------------------------------- 98 99 /** contains the interface to the text of the header of left pages. 100 101 @see com::sun::star::text::Text 102 */ 103 [property] com::sun::star::text::XText HeaderTextLeft; 104 105 //------------------------------------------------------------------------- 106 107 /** contains the interface to the text of the header of right pages. 108 109 @see com::sun::star::text::Text 110 */ 111 [property] com::sun::star::text::XText HeaderTextRight; 112 113 //------------------------------------------------------------------------- 114 115 /** contains the interface to the text of the footer. 116 117 @see com::sun::star::text::Text 118 */ 119 [property] com::sun::star::text::XText FooterText; 120 121 //------------------------------------------------------------------------- 122 123 /** contains the interface to the text of the footer of a left page. 124 125 @see com::sun::star::text::Text 126 */ 127 [property] com::sun::star::text::XText FooterTextLeft; 128 129 //------------------------------------------------------------------------- 130 131 /** contains the interface to the text of the footer of a right page. 132 133 @see com::sun::star::text::Text 134 */ 135 [property] com::sun::star::text::XText FooterTextRight; 136 137 //------------------------------------------------------------------------- 138 139 /** contains the maximum height of the footnote area (in 1/100 mm). 140 141 <p>If set to zero, the height of the current page is used as limit.</p> 142 */ 143 [property] long FootnoteHeight; 144 145 //------------------------------------------------------------------------- 146 147 /** contains the weight of the separator line between the text and 148 the footnote area (in 1/100 mm). 149 */ 150 [property] short FootnoteLineWeight; 151 152 //------------------------------------------------------------------------- 153 154 /** contains the color of the separator line between the text and 155 the footnote area. 156 */ 157 [property] com::sun::star::util::Color FootnoteLineColor; 158 159 //------------------------------------------------------------------------- 160 161 /** contains the relative width of the separator line between the 162 text and the footnote area (in percent). 163 */ 164 [property] byte FootnoteLineRelativeWidth; 165 166 //------------------------------------------------------------------------- 167 168 /** contains the adjustment of the separator line between the text 169 and the footnote area. 170 171 @see com::sun::star::text::HorizontalAdjust 172 */ 173 [property] short FootnoteLineAdjust; 174 175 //------------------------------------------------------------------------- 176 177 /** contains the distance between the text and the separator line 178 between the text and the footnote area (in 1/100 mm). 179 */ 180 [property] long FootnoteLineTextDistance; 181 182 //------------------------------------------------------------------------- 183 184 /** contains the distance between the footnote area and the separator 185 line between the text and the footnote area (in 1/100 mm). 186 */ 187 [property] long FootnoteLineDistance; 188 189}; 190 191//============================================================================= 192 193}; }; }; }; 194 195#endif 196 197