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 #ifndef __com_sun_star_text_TextTableRow_idl__
  20 #define __com_sun_star_text_TextTableRow_idl__
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23 #include <com/sun/star/util/Color.idl>
  24 #include <com/sun/star/style/GraphicLocation.idl>
  25 #include <com/sun/star/text/TableColumnSeparator.idl>
  26
  27
  28
  29  module com {  module sun {  module star {  module text {
  30
  31
  32 /** specifies the properties of a text table row.
  33
  34     @see com::sun::star::TextTable
  35  */
  36 published service TextTableRow
  37 {
  38     interface com::sun::star::beans::XPropertySet;
  39
  40
  41     /** specifies the color of the background.
  42      */
  43     [property] com::sun::star::util::Color BackColor;
  44
  45
  46     /** If `TRUE`, the background color value in "BackColor" is not visible.
  47      */
  48     [property] boolean BackTransparent;
  49
  50
  51     /** contains the URL of a background graphic.
  52      */
  53     [property] string BackGraphicURL;
  54
  55
  56     /** contains the name of the file filter of a background graphic.
  57      */
  58     [property] string BackGraphicFilter;
  59
  60
  61     /** determines the position of the background graphic.@see GraphicLocation
  62      */
  63     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
  64
  65
  66     /** contains the description of the columns in the table row.
  67      */
  68     [property] sequence< com::sun::star::text::TableColumnSeparator >   TableColumnSeparators;
  69
  70
  71     /** contains the height of the table row.
  72      */
  73     [property] long Height;
  74
  75
  76     /** If the value of this property is `TRUE`, the height of the table row
  77         depends on the content of the table cells.
  78      */
  79     [property] boolean IsAutoHeight;
  80
  81
  82         /** If `TRUE`, the row is allowed to be split at page or column breaks.
  83
  84                 @since OOo 2.0
  85          */
  86         [optional, property, maybevoid] boolean IsSplitAllowed;
  87
  88     /** Grab bag of row properties, used as a string-any map for interop purposes.
  89
  90         @since LibreOffice 4.4
  91
  92         <p>This property is intentionally not handled by the ODF filter. Any
  93         member that should be handled there should be first moved out from this grab
  94         bag to a separate property.</p>
  95     */
  96     [optional, property] sequence<com::sun::star::beans::PropertyValue> RowInteropGrabBag;
  97
  98
  99 };
 100
 101
 102 }; }; }; };
 103
 104
 105 #endif
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */