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#ifndef __com_sun_star_text_TextTable_idl__ 24#define __com_sun_star_text_TextTable_idl__ 25 26#ifndef __com_sun_star_text_TextContent_idl__ 27#include <com/sun/star/text/TextContent.idl> 28#endif 29 30#ifndef __com_sun_star_util_Color_idl__ 31#include <com/sun/star/util/Color.idl> 32#endif 33 34#ifndef __com_sun_star_text_XTextTable_idl__ 35#include <com/sun/star/text/XTextTable.idl> 36#endif 37#ifndef __com_sun_star_text_TableColumnSeparator_idl__ 38#include <com/sun/star/text/TableColumnSeparator.idl> 39#endif 40 41#ifndef __com_sun_star_container_XNamed_idl__ 42#include <com/sun/star/container/XNamed.idl> 43#endif 44 45#ifndef __com_sun_star_beans_XPropertySet_idl__ 46#include <com/sun/star/beans/XPropertySet.idl> 47#endif 48 49#ifndef __com_sun_star_style_GraphicLocation_idl__ 50#include <com/sun/star/style/GraphicLocation.idl> 51#endif 52#ifndef __com_sun_star_style_BreakType_idl__ 53#include <com/sun/star/style/BreakType.idl> 54#endif 55#ifndef __com_sun_star_table_ShadowFormat_idl__ 56#include <com/sun/star/table/ShadowFormat.idl> 57#endif 58#ifndef __com_sun_star_table_TableBorder_idl__ 59#include <com/sun/star/table/TableBorder.idl> 60#endif 61#ifndef __com_sun_star_table_XCellRange_idl__ 62#include <com/sun/star/table/XCellRange.idl> 63#endif 64#ifndef __com_sun_star_table_XAutoFormattable_idl__ 65#include <com/sun/star/table/XAutoFormattable.idl> 66#endif 67#ifndef __com_sun_star_chart_XChartDataArray_idl__ 68#include <com/sun/star/chart/XChartDataArray.idl> 69#endif 70#ifndef __com_sun_star_util_XSortable_idl__ 71#include <com/sun/star/util/XSortable.idl> 72#endif 73#ifndef __com_sun_star_sheet_XCellRangeData_idl__ 74#include <com/sun/star/sheet/XCellRangeData.idl> 75#endif 76#ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_ 77#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl> 78#endif 79 80 81//============================================================================= 82 83 module com { module sun { module star { module text { 84 85//============================================================================= 86 87/** is a table of text cells which is anchored to a surrounding text. 88 89 <p>Note: The anchor of the actual implementation for text tables 90 does not have a position in the text. Thus that anchor can not be 91 used for some operation like <member>XTextContent::attach</member> or 92 <member>XText::insertTextContent</member> 93 or other function that require the object to have a position in the text.</p> 94 95 <p>The reason why a text table still needs an anchor is that for example 96 tables should be insertable via <member>XText::insertTextContent</member> 97 and that interface uses a parameter of that type.</p> 98 99 @example 100 101 <p>Create and insert a TextTable:</p> 102 103 <listing> 104 xTable = xTextDoc.createInstance( "com.sun.star.text.TextTable" ) 105 xTable.initialize(5, 8) 106 xTable.HoriOrient = 0 'com::sun::star::text::HoriOrientation::NONE 107 xTable.LeftMargin = 2000 108 xTable.RightMargin = 1500 109 xTextDoc.getText.insertTextContent( xTextRange, xTable, false ) 110 </listing> 111 112 @see com::sun::star::text::Cell 113 @see com::sun::star::text::CellRange 114 @see com::sun::star::text::TableColumns 115 @see com::sun::star::text::TableRows 116 @see com::sun::star::text::TextTableCursor 117 */ 118published service TextTable 119{ 120 service com::sun::star::text::TextContent; 121 122 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier; 123 124 interface com::sun::star::text::XTextTable; 125 126 interface com::sun::star::container::XNamed; 127 128 interface com::sun::star::table::XCellRange; 129 130 interface com::sun::star::chart::XChartDataArray; 131 132 interface com::sun::star::table::XAutoFormattable; 133 134 interface com::sun::star::util::XSortable; 135 136 [optional] interface com::sun::star::sheet::XCellRangeData; 137 138 /** determines the type of break that is applied at the beginning of the table. @see com::sun::star::style::BreakType 139 */ 140 [property] com::sun::star::style::BreakType BreakType; 141 //------------------------------------------------------------------------- 142 143 /** contains the left margin of the table. 144 */ 145 [property] long LeftMargin; 146 //------------------------------------------------------------------------- 147 148 /** contains the right margin of the table. 149 */ 150 [property] long RightMargin; 151 //------------------------------------------------------------------------- 152 153 /** contains the horizontal orientation. @see com::sun::star::text::HoriOrientation 154 */ 155 [property] short HoriOrient; 156 //------------------------------------------------------------------------- 157 158 /** Setting this property to TRUE prevents page or column 159 breaks between this table and the following paragraph or text table. 160 */ 161 [property] boolean KeepTogether; 162 //------------------------------------------------------------------------- 163 164 /** Setting this property to FALSE prevents the table from 165 getting spread on two pages. 166 */ 167 [property] boolean Split; 168 //------------------------------------------------------------------------- 169 170 /** If a page break property is set at the table, 171 this property contains the new value for the page number. 172 */ 173 [property] short PageNumberOffset; 174 //------------------------------------------------------------------------- 175 176 /** If this property is set, it creates a page break before the 177 table and assigns the value as the name of the new page style sheet to use. 178 */ 179 [property] string PageDescName; 180 //------------------------------------------------------------------------- 181 182 /** determines the width of the table relative to its environment. 183 */ 184 [property] short RelativeWidth; 185 //------------------------------------------------------------------------- 186 /** determines if the value of the relative width is valid. 187 */ 188 [property] boolean IsWidthRelative; 189 //------------------------------------------------------------------------- 190 191 /** determines if the first row of the table is repeated on every new page. 192 */ 193 [property] boolean RepeatHeadline; 194 //------------------------------------------------------------------------- 195 /** determines the number of rows of the table repeated on every new page. 196 */ 197 [optional, property] long HeaderRowCount; 198 //------------------------------------------------------------------------- 199 200 /** determines the type, color and size of the shadow. @see com::sun::star::table::ShadowFormat 201 */ 202 [property] com::sun::star::table::ShadowFormat ShadowFormat; 203 //------------------------------------------------------------------------- 204 205 /** determines the top margin. 206 */ 207 [property] long TopMargin; 208 //------------------------------------------------------------------------- 209 210 /** determines the bottom margin. 211 */ 212 [property] long BottomMargin; 213 //------------------------------------------------------------------------- 214 215 /** determines if the background color is transparent. 216 */ 217 [property] boolean BackTransparent; 218 //------------------------------------------------------------------------- 219 220 /** contains the absolute table width. 221 222 <p>As this is only a describing property the value of the actual table may vary depending on the 223 environment the table is located in and the settings of LeftMargin, 224 RightMargin and HoriOrient. </p> 225 */ 226 [property] long Width; 227 //------------------------------------------------------------------------- 228 229 /** determines if the first row of the table should be treated as 230 axis labels when a chart is to be created. 231 */ 232 [property] boolean ChartRowAsLabel; 233 //------------------------------------------------------------------------- 234 235 /** determines if the first column of the table should be treated as 236 axis labels when a chart is to be created. 237 */ 238 [property] boolean ChartColumnAsLabel; 239 //------------------------------------------------------------------------- 240 241 /** contains the description of the table borders. @see com::sun::star::table::TableBorder 242 */ 243 [property] com::sun::star::table::TableBorder TableBorder; 244 //------------------------------------------------------------------------- 245 246 /** contains the column description of the table. 247 @see com::sun::star::text::TableColumnSeparator 248 */ 249 [property] sequence<com::sun::star::text::TableColumnSeparator> TableColumnSeparators; 250 //------------------------------------------------------------------------- 251 252 /** contains the sum of the column width values used in TableColumnSeparators. 253 */ 254 [property] short TableColumnRelativeSum; 255 //------------------------------------------------------------------------- 256 257 /** contains the color of the background. 258 */ 259 [property] com::sun::star::util::Color BackColor; 260 //------------------------------------------------------------------------- 261 262 /** contains the URL for the background graphic. 263 */ 264 [property] string BackGraphicURL; 265 266 //------------------------------------------------------------------------- 267 268 /** contains the name of the file filter for the background graphic. 269 */ 270 [property] string BackGraphicFilter; 271 272 //------------------------------------------------------------------------- 273 274 /** determines the position of the background graphic.@see GraphicLocation 275 */ 276 [property] com::sun::star::style::GraphicLocation BackGraphicLocation; 277 278 //------------------------------------------------------------------------- 279 280 /** determines whether borders of neighbouring table cells are 281 * collapsed into one 282 */ 283 [optional, property] boolean CollapsingBorders; 284 285}; 286 287//============================================================================= 288 289}; }; }; }; 290 291#endif 292