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