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

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