offapi/com/sun/star/text/TextTable.idl

   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 module com {  module sun {  module star {  module text {
  21
  22 /** is a table of text cells which is anchored to a surrounding text.
  23
  24     <p>Note: The anchor of the actual implementation for text tables
  25     does not have a position in the text. Thus that anchor can not be
  26     used for some operation like XTextContent::attach() or
  27     XText::insertTextContent()
  28     or other function that require the object to have a position in the text.</p>
  29
  30     <p>The reason why a text table still needs an anchor is that for example
  31     tables should be insertable via XText::insertTextContent()
  32     and that interface uses a parameter of that type.</p>
  33
  34     <p>Example: Create and insert a TextTable:</p>
  35
  36     @code{.bas}
  37     xTable = xTextDoc.createInstance( "com.sun.star.text.TextTable" )
  38     xTable.initialize(5, 8)
  39     xTable.HoriOrient = 0 'com::sun::star::text::HoriOrientation::NONE
  40     xTable.LeftMargin = 2000
  41     xTable.RightMargin = 1500
  42     xTextDoc.getText.insertTextContent( xTextRange, xTable, false )
  43     @endcode
  44
  45     @see    com::sun::star::text::Cell
  46     @see    com::sun::star::text::CellRange
  47     @see    com::sun::star::text::TableColumns
  48     @see    com::sun::star::text::TableRows
  49     @see    com::sun::star::text::TextTableCursor
  50  */
  51 published 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
  71     /** determines the type of break that is applied at the beginning of the table.@see com::sun::star::style::BreakType
  72      */
  73     [property] com::sun::star::style::BreakType BreakType;
  74
  75     /** contains the left margin of the table.
  76      */
  77     [property] long LeftMargin;
  78
  79     /** contains the right margin of the table.
  80      */
  81     [property] long RightMargin;
  82
  83     /** contains the horizontal orientation. @see com::sun::star::text::HoriOrientation
  84      */
  85     [property] short HoriOrient;
  86
  87     /** Setting this property to TRUE prevents page or column
  88         breaks between this table and the following paragraph or text table.
  89      */
  90     [property] boolean KeepTogether;
  91
  92     /** Setting this property to FALSE prevents the table from
  93         getting spread on two pages.
  94      */
  95     [property] boolean Split;
  96
  97     /** If a page break property is set at the table,
  98         this property contains the new value for the page number.
  99      */
 100     [property] short PageNumberOffset;
 101
 102     /** If this property is set, it creates a page break before the
 103         table and assigns the value as the name of the new page style sheet to use.
 104      */
 105     [property] string PageDescName;
 106
 107     /** determines the width of the table relative to its environment.
 108      */
 109     [property] short RelativeWidth;
 110     /** determines if the value of the relative width is valid.
 111      */
 112     [property] boolean IsWidthRelative;
 113
 114     /** determines if the first row of the table is repeated on every new page.
 115      */
 116     [property] boolean RepeatHeadline;
 117         /** determines the number of rows of the table repeated on every new page.
 118          */
 119         [optional, property] long HeaderRowCount;
 120
 121     /** determines the type, color and size of the shadow.@see com::sun::star::table::ShadowFormat
 122      */
 123     [property] com::sun::star::table::ShadowFormat ShadowFormat;
 124
 125     /** determines the top margin.
 126      */
 127     [property] long TopMargin;
 128
 129     /** determines the bottom margin.
 130      */
 131     [property] long BottomMargin;
 132
 133     /** determines if the background color is transparent.
 134      */
 135     [property] boolean BackTransparent;
 136
 137     /** contains the absolute table width.
 138
 139         <p>As this is only a describing property the value of the actual table may vary depending on the
 140         environment the table is located in and the settings of LeftMargin,
 141         RightMargin and HoriOrient. </p>
 142      */
 143     [property] long Width;
 144
 145     /** determines if the first row of the table should be treated as
 146         axis labels when a chart is to be created.
 147      */
 148     [property] boolean ChartRowAsLabel;
 149
 150     /** determines if the first column of the table should be treated as
 151         axis labels when a chart is to be created.
 152      */
 153     [property] boolean ChartColumnAsLabel;
 154
 155     /** contains the description of the table borders. @see com::sun::star::table::TableBorder
 156      */
 157     [property] com::sun::star::table::TableBorder TableBorder;
 158
 159     /** contains the column description of the table.
 160              @see com::sun::star::text::TableColumnSeparator
 161      */
 162     [property] sequence<com::sun::star::text::TableColumnSeparator> TableColumnSeparators;
 163
 164     /** contains the sum of the column width values used in TableColumnSeparators.
 165      */
 166     [property] short TableColumnRelativeSum;
 167
 168     /** contains the color of the background.
 169      */
 170     [property] com::sun::star::util::Color BackColor;
 171
 172     /** contains the URL for the background graphic.
 173
 174         @deprecated as of LibreOffice 6.1 - use BackGraphic instead
 175
 176         Note the new behaviour since it this was deprecated:
 177         This property can only be set and only external URLs are
 178         supported (no more vnd.sun.star.GraphicObject scheme). When an
 179         URL is set, then it will load the graphic and set the BackGraphic
 180         property.
 181      */
 182     [property] string BackGraphicURL;
 183
 184     /** contains the name of the file filter for the background graphic.
 185      */
 186     [property] string BackGraphicFilter;
 187
 188
 189     /** determines the position of the background graphic.@see GraphicLocation
 190      */
 191     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
 192
 193
 194     /** determines whether borders of neighboring table cells are
 195      * collapsed into one
 196      */
 197     [optional, property] boolean CollapsingBorders;
 198
 199     /** Grab bag of table properties, used as a string-any map for interim interop purposes.
 200
 201         @since LibreOffice 4.3
 202
 203         <p>This property is intentionally not handled by the ODF filter. Any
 204         member that should be handled there should be first moved out from this grab
 205         bag to a separate property.</p>
 206     */
 207     [optional, property] sequence<com::sun::star::beans::PropertyValue> TableInteropGrabBag;
 208
 209     /** contains the name of table style used by the table.
 210
 211         @since LibreOffice 5.3
 212      */
 213     [optional, property] string TableTemplateName;
 214
 215     /** contains the graphic for the background.
 216
 217         @since LibreOffice 6.1
 218      */
 219     [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
 220 };
 221
 222
 223 }; }; }; };
 224
 225 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */