LibreOffice: com/sun/star/text/TextTable.idl Source File

LibreOffice LibreOffice 6.1 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
23 #include <com/sun/star/text/TextContent.idl>
24 #include <com/sun/star/util/Color.idl>
25 #include <com/sun/star/text/XTextTable.idl>
26 #include <com/sun/star/text/TableColumnSeparator.idl>
27 #include <com/sun/star/container/XNamed.idl>
28 #include <com/sun/star/beans/XPropertySet.idl>
29 #include <com/sun/star/style/GraphicLocation.idl>
30 #include <com/sun/star/style/BreakType.idl>
31 #include <com/sun/star/table/ShadowFormat.idl>
32 #include <com/sun/star/table/TableBorder.idl>
33 #include <com/sun/star/table/XCellRange.idl>
34 #include <com/sun/star/table/XAutoFormattable.idl>
35 #include <com/sun/star/chart/XChartDataArray.idl>
36 #include <com/sun/star/util/XSortable.idl>
37 #include <com/sun/star/sheet/XCellRangeData.idl>
38 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
39 #include <com/sun/star/graphic/XGraphic.idl>
40
41 module com { module sun { module star { module text {
42
72 published service TextTable
73 {
74 service com::sun::star::text::TextContent;
75
76 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
77
78 interface com::sun::star::text::XTextTable;
79
80 interface com::sun::star::container::XNamed;
81
82 interface com::sun::star::table::XCellRange;
83
84 interface com::sun::star::chart::XChartDataArray;
85
86 interface com::sun::star::table::XAutoFormattable;
87
88 interface com::sun::star::util::XSortable;
89
90 [optional] interface com::sun::star::sheet::XCellRangeData;
91
94 [property] com::sun::star::style::BreakType BreakType;
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
144 [property] com::sun::star::table::ShadowFormat ShadowFormat;
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
178 [property] com::sun::star::table::TableBorder TableBorder;
179
183 [property] sequence<com::sun::star::text::TableColumnSeparator> TableColumnSeparators;
184
187 [property] short TableColumnRelativeSum;
188
191 [property] com::sun::star::util::Color BackColor;
192
203 [property] string BackGraphicURL;
204
207 [property] string BackGraphicFilter;
208
209
212 [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
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
240 [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
241 };
242
243
244 }; }; }; };
245
246 #endif
247
248 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::text::TextTable::BackGraphicFilter
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition: TextTable.idl:207
com::sun::star::text::TextTable
is a table of text cells which is anchored to a surrounding text.
Definition: TextTable.idl:72
com::sun::star::container::XNamed
specifies the name of the object.
Definition: XNamed.idl:32
com::sun::star::util::XSortable
makes it possible to sort the contents of this object.
Definition: XSortable.idl:55
com::sun::star::table::XAutoFormattable
provides a method to apply TableAutoFormats to a cell range.
Definition: XAutoFormattable.idl:32
com::sun::star::text::TextTable::PageNumberOffset
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::text::TextTable::BackGraphicLocation
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: TextTable.idl:212
XAutoFormattable.idl
BreakType.idl
com::sun::star::text::TextTable::PageDescName
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
ShadowFormat.idl
com::sun::star::text::TextTable::ChartColumnAsLabel
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
com
Definition: Ambiguous.idl:22
com::sun::star::text::TextTable::BackGraphic
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic for the background.
Definition: TextTable.idl:240
com::sun::star::text::TextTable::BackColor
com::sun::star::util::Color BackColor
contains the color of the background.
Definition: TextTable.idl:191
com::sun::star::text::TextTable::RelativeWidth
short RelativeWidth
determines the width of the table relative to its environment.
Definition: TextTable.idl:130
com::sun::star::text::TextTable::HoriOrient
short HoriOrient
contains the horizontal orientation.
Definition: TextTable.idl:106
com::sun::star::text::TextTable::TopMargin
long TopMargin
determines the top margin.
Definition: TextTable.idl:148
GraphicLocation.idl
com::sun::star::text::TextTable::ChartRowAsLabel
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
com::sun::star::text::TextContent
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Definition: TextContent.idl:48
com::sun::star::text::TextTable::TableColumnSeparators
sequence< com::sun::star::text::TableColumnSeparator > TableColumnSeparators
contains the column description of the table.
Definition: TextTable.idl:183
com::sun::star::text::TextTable::TableColumnRelativeSum
short TableColumnRelativeSum
contains the sum of the column width values used in TableColumnSeparators.
Definition: TextTable.idl:187
com::sun::star::style::BreakType
BreakType
These enumeration values are used to specify if and how a page or column break is applied...
Definition: BreakType.idl:29
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:43
XSortable.idl
com::sun::star::style::GraphicLocation
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:29
com::sun::star::xml::UserDefinedAttributesSupplier
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::text::TextTable::TableBorder
com::sun::star::table::TableBorder TableBorder
contains the description of the table borders.
Definition: TextTable.idl:178
com::sun::star::table::TableBorder
contains the style settings of the border lines of all cells in a cell range.
Definition: TableBorder.idl:40
com::sun::star::text::TextTable::TableTemplateName
string TableTemplateName
contains the name of table style used by the table.
Definition: TextTable.idl:234
com::sun::star::text::TextTable::KeepTogether
boolean KeepTogether
Setting this property to TRUE prevents page or column breaks between this table and the following par...
Definition: TextTable.idl:111
XCellRangeData.idl
com::sun::star::text::TextTable::RightMargin
long RightMargin
contains the right margin of the table.
Definition: TextTable.idl:102
XNamed.idl
com::sun::star::text::TextTable::HeaderRowCount
long HeaderRowCount
determines the number of rows of the table repeated on every new page.
Definition: TextTable.idl:140
com::sun::star::text::TextTable::RepeatHeadline
boolean RepeatHeadline
determines if the first row of the table is repeated on every new page.
Definition: TextTable.idl:137
XCellRange.idl
com::sun::star::table::ShadowFormat
describes the settings of a cell shadow.
Definition: ShadowFormat.idl:32
com::sun::star::text::TextTable::Split
boolean Split
Setting this property to FALSE prevents the table from getting spread on two pages.
Definition: TextTable.idl:116
com::sun::star::text::TextTable::BackTransparent
boolean BackTransparent
determines if the background color is transparent.
Definition: TextTable.idl:156
XTextTable.idl
com::sun::star::text::TextTable::BottomMargin
long BottomMargin
determines the bottom margin.
Definition: TextTable.idl:152
com::sun::star::text::TextTable::IsWidthRelative
boolean IsWidthRelative
determines if the value of the relative width is valid.
Definition: TextTable.idl:133
XChartDataArray.idl
com::sun::star::chart::XChartDataArray
gives access to data represented as an array of rows.
Definition: XChartDataArray.idl:35
com::sun::star::table::XCellRange
provides access to the cells or to sub-ranges of a cell range.
Definition: XCellRange.idl:35
TableColumnSeparator.idl
com::sun::star::text::TextTable::CollapsingBorders
boolean CollapsingBorders
determines whether borders of neighboring table cells are collapsed into one
Definition: TextTable.idl:218
com::sun::star::text::TextTable::BackGraphicURL
string BackGraphicURL
contains the URL for the background graphic.
Definition: TextTable.idl:203
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
com::sun::star::sheet::XCellRangeData
allows to get and set an array of data from a cell range.
Definition: XCellRangeData.idl:32
Color.idl
XPropertySet.idl
com::sun::star::text::TextTable::LeftMargin
long LeftMargin
contains the left margin of the table.
Definition: TextTable.idl:98
com::sun::star::text::TextTable::ShadowFormat
com::sun::star::table::ShadowFormat ShadowFormat
determines the type, color and size of the shadow.
Definition: TextTable.idl:144
com::sun::star::text::TextTable::TableInteropGrabBag
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
com::sun::star::text::TextTable::Width
long Width
contains the absolute table width.
Definition: TextTable.idl:164
UserDefinedAttributesSupplier.idl
XGraphic.idl
com::sun::star::text::XTextTable
manages a text table.
Definition: XTextTable.idl:42
TextContent.idl
TableBorder.idl