offapi/com/sun/star/text/TextTableRow.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 /** specifies the properties of a text table row.
  23
  24     @see com::sun::star::TextTable
  25  */
  26 published service TextTableRow
  27 {
  28     interface com::sun::star::beans::XPropertySet;
  29
  30
  31     /** specifies the color of the background.
  32      */
  33     [property] com::sun::star::util::Color BackColor;
  34
  35
  36     /** If `TRUE`, the background color value in "BackColor" is not visible.
  37      */
  38     [property] boolean BackTransparent;
  39
  40
  41     /** contains the URL of a background graphic.
  42
  43         @deprecated as of LibreOffice 6.1 - use BackGraphic instead
  44
  45         Note the new behaviour since it this was deprecated:
  46         This property can only be set and only external URLs are
  47         supported (no more vnd.sun.star.GraphicObject scheme). When an
  48         URL is set, then it will load the graphic and set the BackGraphic
  49         property.
  50      */
  51     [property] string BackGraphicURL;
  52
  53     /** contains the name of the file filter of a background graphic.
  54      */
  55     [property] string BackGraphicFilter;
  56
  57
  58     /** determines the position of the background graphic.@see GraphicLocation
  59      */
  60     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
  61
  62
  63     /** contains the description of the columns in the table row.
  64      */
  65     [property] sequence< com::sun::star::text::TableColumnSeparator >   TableColumnSeparators;
  66
  67
  68     /** contains the height of the table row.
  69      */
  70     [property] long Height;
  71
  72
  73     /** If the value of this property is `TRUE`, the height of the table row
  74         depends on the content of the table cells.
  75      */
  76     [property] boolean IsAutoHeight;
  77
  78
  79         /** If `TRUE`, the row is allowed to be split at page or column breaks.
  80
  81                 @since OOo 2.0
  82          */
  83         [optional, property, maybevoid] boolean IsSplitAllowed;
  84
  85     /** Grab bag of row properties, used as a string-any map for interop purposes.
  86
  87         @since LibreOffice 4.4
  88
  89         <p>This property is intentionally not handled by the ODF filter. Any
  90         member that should be handled there should be first moved out from this grab
  91         bag to a separate property.</p>
  92     */
  93     [optional, property] sequence<com::sun::star::beans::PropertyValue> RowInteropGrabBag;
  94
  95     /** contains the graphic of the background.
  96
  97         @since LibreOffice 6.1
  98      */
  99     [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
 100
 101     /** If TRUE, the table row wasn't deleted or inserted with its tracked cell content
 102
 103         @since LibreOffice 7.2
 104      */
 105
 106         [optional, property] boolean HasTextChangesOnly;
 107
 108 };
 109
 110
 111 }; }; }; };
 112
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */