LibreOffice
LibreOffice 6.2 SDK API Reference
TextTable.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 #ifndef __com_sun_star_text_TextTable_idl__
21 #define __com_sun_star_text_TextTable_idl__
22 
40 
41 module com { module sun { module star { module text {
42 
72 published service TextTable
73 {
75 
77 
79 
81 
83 
85 
87 
89 
91 
95 
98  [property] long LeftMargin;
99 
102  [property] long RightMargin;
103 
106  [property] short HoriOrient;
107 
111  [property] boolean KeepTogether;
112 
116  [property] boolean Split;
117 
121  [property] short PageNumberOffset;
122 
126  [property] string PageDescName;
127 
130  [property] short RelativeWidth;
133  [property] boolean IsWidthRelative;
134 
137  [property] boolean RepeatHeadline;
140  [optional, property] long HeaderRowCount;
141 
145 
148  [property] long TopMargin;
149 
152  [property] long BottomMargin;
153 
156  [property] boolean BackTransparent;
157 
164  [property] long Width;
165 
169  [property] boolean ChartRowAsLabel;
170 
174  [property] boolean ChartColumnAsLabel;
175 
179 
183  [property] sequence<com::sun::star::text::TableColumnSeparator> TableColumnSeparators;
184 
187  [property] short TableColumnRelativeSum;
188 
192 
203  [property] string BackGraphicURL;
204 
207  [property] string BackGraphicFilter;
208 
209 
213 
214 
218  [optional, property] boolean CollapsingBorders;
219 
228  [optional, property] sequence<com::sun::star::beans::PropertyValue> TableInteropGrabBag;
229 
234  [optional, property] string TableTemplateName;
235 
241 };
242 
243 
244 }; }; }; };
245 
246 #endif
247 
248 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition: TextTable.idl:207
is a table of text cells which is anchored to a surrounding text.
Definition: TextTable.idl:72
specifies the name of the object.
Definition: XNamed.idl:32
makes it possible to sort the contents of this object.
Definition: XSortable.idl:55
provides a method to apply TableAutoFormats to a cell range.
Definition: XAutoFormattable.idl:32
short PageNumberOffset
If a page break property is set at the table, this property contains the new value for the page numbe...
Definition: TextTable.idl:121
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: TextTable.idl:212
string PageDescName
If this property is set, it creates a page break before the table and assigns the value as the name o...
Definition: TextTable.idl:126
boolean ChartColumnAsLabel
determines if the first column of the table should be treated as axis labels when a chart is to be cr...
Definition: TextTable.idl:174
Definition: Ambiguous.idl:22
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic for the background.
Definition: TextTable.idl:240
com::sun::star::util::Color BackColor
contains the color of the background.
Definition: TextTable.idl:191
short RelativeWidth
determines the width of the table relative to its environment.
Definition: TextTable.idl:130
short HoriOrient
contains the horizontal orientation.
Definition: TextTable.idl:106
long TopMargin
determines the top margin.
Definition: TextTable.idl:148
boolean ChartRowAsLabel
determines if the first row of the table should be treated as axis labels when a chart is to be creat...
Definition: TextTable.idl:169
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Definition: TextContent.idl:48
sequence< com::sun::star::text::TableColumnSeparator > TableColumnSeparators
contains the column description of the table.
Definition: TextTable.idl:183
short TableColumnRelativeSum
contains the sum of the column width values used in TableColumnSeparators.
Definition: TextTable.idl:187
BreakType
These enumeration values are used to specify if and how a page or column break is applied...
Definition: BreakType.idl:29
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:43
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:29
A component that supports this service preserves XML attributes, unknown by its parser, that belong to the XML element representing it (the component).
Definition: UserDefinedAttributesSupplier.idl:32
com::sun::star::table::TableBorder TableBorder
contains the description of the table borders.
Definition: TextTable.idl:178
contains the style settings of the border lines of all cells in a cell range.
Definition: TableBorder.idl:40
string TableTemplateName
contains the name of table style used by the table.
Definition: TextTable.idl:234
boolean KeepTogether
Setting this property to TRUE prevents page or column breaks between this table and the following par...
Definition: TextTable.idl:111
long RightMargin
contains the right margin of the table.
Definition: TextTable.idl:102
long HeaderRowCount
determines the number of rows of the table repeated on every new page.
Definition: TextTable.idl:140
boolean RepeatHeadline
determines if the first row of the table is repeated on every new page.
Definition: TextTable.idl:137
describes the settings of a cell shadow.
Definition: ShadowFormat.idl:32
boolean Split
Setting this property to FALSE prevents the table from getting spread on two pages.
Definition: TextTable.idl:116
boolean BackTransparent
determines if the background color is transparent.
Definition: TextTable.idl:156
long BottomMargin
determines the bottom margin.
Definition: TextTable.idl:152
boolean IsWidthRelative
determines if the value of the relative width is valid.
Definition: TextTable.idl:133
gives access to data represented as an array of rows.
Definition: XChartDataArray.idl:35
provides access to the cells or to sub-ranges of a cell range.
Definition: XCellRange.idl:35
boolean CollapsingBorders
determines whether borders of neighboring table cells are collapsed into one
Definition: TextTable.idl:218
string BackGraphicURL
contains the URL for the background graphic.
Definition: TextTable.idl:203
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
allows to get and set an array of data from a cell range.
Definition: XCellRangeData.idl:32
long LeftMargin
contains the left margin of the table.
Definition: TextTable.idl:98
com::sun::star::table::ShadowFormat ShadowFormat
determines the type, color and size of the shadow.
Definition: TextTable.idl:144
sequence< com::sun::star::beans::PropertyValue > TableInteropGrabBag
Grab bag of table properties, used as a string-any map for interim interop purposes.
Definition: TextTable.idl:228
long Width
contains the absolute table width.
Definition: TextTable.idl:164
manages a text table.
Definition: XTextTable.idl:42