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

LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
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
20module com { module sun { module star { module text {
21
51published service TextTable
52{
53 service com::sun::star::text::TextContent;
54
55 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
56
57 interface com::sun::star::text::XTextTable;
58
59 interface com::sun::star::container::XNamed;
60
61 interface com::sun::star::table::XCellRange;
62
63 interface com::sun::star::chart::XChartDataArray;
64
65 interface com::sun::star::table::XAutoFormattable;
66
67 interface com::sun::star::util::XSortable;
68
69 [optional] interface com::sun::star::sheet::XCellRangeData;
70
73 [property] com::sun::star::style::BreakType BreakType;
74
77 [property] long LeftMargin;
78
81 [property] long RightMargin;
82
85 [property] short HoriOrient;
86
90 [property] boolean KeepTogether;
91
95 [property] boolean Split;
96
100 [property] short PageNumberOffset;
101
105 [property] string PageDescName;
106
109 [property] short RelativeWidth;
112 [property] boolean IsWidthRelative;
113
116 [property] boolean RepeatHeadline;
119 [optional, property] long HeaderRowCount;
120
123 [property] com::sun::star::table::ShadowFormat ShadowFormat;
124
127 [property] long TopMargin;
128
131 [property] long BottomMargin;
132
135 [property] boolean BackTransparent;
136
143 [property] long Width;
144
148 [property] boolean ChartRowAsLabel;
149
153 [property] boolean ChartColumnAsLabel;
154
157 [property] com::sun::star::table::TableBorder TableBorder;
158
162 [property] sequence<com::sun::star::text::TableColumnSeparator> TableColumnSeparators;
163
166 [property] short TableColumnRelativeSum;
167
170 [property] com::sun::star::util::Color BackColor;
171
182 [property] string BackGraphicURL;
183
186 [property] string BackGraphicFilter;
187
188
191 [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
192
193
197 [optional, property] boolean CollapsingBorders;
198
207 [optional, property] sequence<com::sun::star::beans::PropertyValue> TableInteropGrabBag;
208
213 [optional, property] string TableTemplateName;
214
219 [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
220};
221
222
223}; }; }; };
224
225/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::chart::XChartDataArray
gives access to data represented as an array of rows.
Definition generated_idl_chapter_refs.idl:143
com::sun::star::container::XNamed
specifies the name of the object.
Definition generated_idl_chapter_refs.idl:4524
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition XGraphic.idl:38
com::sun::star::sheet::XCellRangeData
allows to get and set an array of data from a cell range.
Definition generated_idl_chapter_refs.idl:5273
com::sun::star::table::XAutoFormattable
provides a method to apply TableAutoFormats to a cell range.
Definition generated_idl_chapter_refs.idl:5234
com::sun::star::table::XCellRange
provides access to the cells or to sub-ranges of a cell range.
Definition generated_idl_chapter_refs.idl:3721
com::sun::star::text::XTextTable
manages a text table.
Definition XTextTable.idl:31
com::sun::star::util::XSortable
makes it possible to sort the contents of this object.
Definition generated_idl_chapter_refs.idl:5416
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:28
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:28
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition Color.idl:34
com
Definition Ambiguous.idl:20
com::sun::star::text::TextContent
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Definition generated_idl_chapter_refs.idl:3102
com::sun::star::text::TextTable::RelativeWidth
short RelativeWidth
determines the width of the table relative to its environment.
Definition TextTable.idl:109
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:116
com::sun::star::text::TextTable::TableTemplateName
string TableTemplateName
contains the name of table style used by the table.
Definition TextTable.idl:213
com::sun::star::text::TextTable::RightMargin
long RightMargin
contains the right margin of the table.
Definition TextTable.idl:81
com::sun::star::text::TextTable::TableColumnSeparators
sequence< com::sun::star::text::TableColumnSeparator > TableColumnSeparators
contains the column description of the table.
Definition TextTable.idl:162
com::sun::star::text::TextTable::Width
long Width
contains the absolute table width.
Definition TextTable.idl:143
com::sun::star::text::TextTable::BackGraphicLocation
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition TextTable.idl:191
com::sun::star::text::TextTable::CollapsingBorders
boolean CollapsingBorders
determines whether borders of neighboring table cells are collapsed into one
Definition TextTable.idl:197
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:153
com::sun::star::text::TextTable::ShadowFormat
com::sun::star::table::ShadowFormat ShadowFormat
determines the type, color and size of the shadow.
Definition TextTable.idl:123
com::sun::star::text::TextTable::IsWidthRelative
boolean IsWidthRelative
determines if the value of the relative width is valid.
Definition TextTable.idl:112
com::sun::star::text::TextTable::BackColor
com::sun::star::util::Color BackColor
contains the color of the background.
Definition TextTable.idl:170
com::sun::star::text::TextTable::BackGraphic
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic for the background.
Definition TextTable.idl:219
com::sun::star::text::TextTable::BackGraphicURL
string BackGraphicURL
contains the URL for the background graphic.
Definition TextTable.idl:182
com::sun::star::text::TextTable::TopMargin
long TopMargin
determines the top margin.
Definition TextTable.idl:127
com::sun::star::text::TextTable::BottomMargin
long BottomMargin
determines the bottom margin.
Definition TextTable.idl:131
com::sun::star::text::TextTable::BreakType
com::sun::star::style::BreakType BreakType
determines the type of break that is applied at the beginning of the table.
Definition TextTable.idl:73
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:90
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:207
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:100
com::sun::star::text::TextTable::TableBorder
com::sun::star::table::TableBorder TableBorder
contains the description of the table borders.
Definition TextTable.idl:157
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:148
com::sun::star::text::TextTable::HeaderRowCount
long HeaderRowCount
determines the number of rows of the table repeated on every new page.
Definition TextTable.idl:119
com::sun::star::text::TextTable::LeftMargin
long LeftMargin
contains the left margin of the table.
Definition TextTable.idl:77
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:95
com::sun::star::text::TextTable::BackGraphicFilter
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition TextTable.idl:186
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:105
com::sun::star::text::TextTable::TableColumnRelativeSum
short TableColumnRelativeSum
contains the sum of the column width values used in TableColumnSeparators.
Definition TextTable.idl:166
com::sun::star::text::TextTable::HoriOrient
short HoriOrient
contains the horizontal orientation.
Definition TextTable.idl:85
com::sun::star::text::TextTable::BackTransparent
boolean BackTransparent
determines if the background color is transparent.
Definition TextTable.idl:135
com::sun::star::xml::UserDefinedAttributesSupplier
A component that supports this service preserves XML attributes, unknown by its parser,...
Definition UserDefinedAttributesSupplier.idl:29
com::sun::star::table::ShadowFormat
describes the settings of a cell shadow.
Definition ShadowFormat.idl:27
com::sun::star::table::TableBorder
contains the style settings of the border lines of all cells in a cell range.
Definition TableBorder.idl:36