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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_text_TextTableRow_idl__
  28 #define __com_sun_star_text_TextTableRow_idl__
  29
  30 #ifndef __com_sun_star_beans_XPropertySet_idl__
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_util_Color_idl__
  35 #include <com/sun/star/util/Color.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_style_GraphicLocation_idl__
  39 #include <com/sun/star/style/GraphicLocation.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_text_TableColumnSeparator_idl__
  43 #include <com/sun/star/text/TableColumnSeparator.idl>
  44 #endif
  45
  46
  47 //=============================================================================
  48
  49  module com {  module sun {  module star {  module text {
  50
  51 //=============================================================================
  52
  53 /** specifies the properties of a text table row.
  54
  55     @see com::sun::star::TextTable
  56  */
  57 published service TextTableRow
  58 {
  59     interface com::sun::star::beans::XPropertySet;
  60
  61     //-------------------------------------------------------------------------
  62
  63     /** specifies the color of the background.
  64      */
  65     [property] com::sun::star::util::Color BackColor;
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** If <TRUE/>, the background color value in "BackColor" is not visible.
  70      */
  71     [property] boolean BackTransparent;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** contains the URL of a background graphic.
  76      */
  77     [property] string BackGraphicURL;
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** contains the name of the file filter of a background graphic.
  82      */
  83     [property] string BackGraphicFilter;
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** determines the position of the background graphic.@see GraphicLocation
  88      */
  89     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** contains the description of the columns in the table row.
  94      */
  95     [property] sequence< com::sun::star::text::TableColumnSeparator >   TableColumnSeparators;
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** contains the height of the table row.
 100      */
 101     [property] long Height;
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** If the value of this property is <TRUE/>, the height of the table row
 106         depends on the content of the table cells.
 107      */
 108     [property] boolean IsAutoHeight;
 109
 110         //-------------------------------------------------------------------------
 111
 112         /** If <TRUE/>, the row is allowed to be split at page or column breaks.
 113
 114                 @since OOo 2.0.0
 115          */
 116         [optional, property, maybevoid] boolean IsSplitAllowed;
 117
 118
 119 };
 120
 121 //=============================================================================
 122
 123 }; }; }; };
 124
 125
 126 #endif