offapi/com/sun/star/table/CellProperties.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: CellProperties.idl,v $
  10  * $Revision: 1.13 $
  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
  31 #ifndef __com_sun_star_table_CellProperties_idl__
  32 #define __com_sun_star_table_CellProperties_idl__
  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_beans_XPropertySet_idl__
  39 #include <com/sun/star/beans/XPropertySet.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_ShadowFormat_idl__
  43 #include <com/sun/star/table/ShadowFormat.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_table_CellHoriJustify_idl__
  47 #include <com/sun/star/table/CellHoriJustify.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_table_CellVertJustify_idl__
  51 #include <com/sun/star/table/CellVertJustify.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_table_CellOrientation_idl__
  55 #include <com/sun/star/table/CellOrientation.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_util_CellProtection_idl__
  59 #include <com/sun/star/util/CellProtection.idl>
  60 #endif
  61
  62 #ifndef __com_sun_star_table_TableBorder_idl__
  63 #include <com/sun/star/table/TableBorder.idl>
  64 #endif
  65
  66 #ifndef __com_sun_star_table_BorderLine_idl__
  67 #include <com/sun/star/table/BorderLine.idl>
  68 #endif
  69
  70 #ifndef __com_sun_star_container_XNameContainer_idl__
  71 #include <com/sun/star/container/XNameContainer.idl>
  72 #endif
  73
  74 //=============================================================================
  75
  76 module com {  module sun {  module star {  module table {
  77
  78 //=============================================================================
  79
  80 /** contains the properties of a table cell.
  81
  82     @see com::sun::star::table::Cell
  83     @see com::sun::star::table::CellRange
  84  */
  85 published service CellProperties
  86 {
  87     //-------------------------------------------------------------------------
  88
  89 //!published service PropertySet
  90     /** provides access to the properties.
  91      */
  92     interface com::sun::star::beans::XPropertySet;
  93
  94     //=========================================================================
  95
  96     /** contains the name of the style of the cell.
  97      */
  98     [optional, property] string CellStyle;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** contains the cell background color.
 103      */
 104     [property] com::sun::star::util::Color CellBackColor;
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** is <TRUE/>, if the cell background is transparent.
 109
 110         <p>In this case the <member>CellProperties::CellBackColor</member>
 111         value is not used.</p>
 112      */
 113     [property] boolean IsCellBackgroundTransparent;
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** contains the horizontal alignment of the cell contents.
 118      */
 119     [property] com::sun::star::table::CellHoriJustify HoriJustify;
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** contains the vertical alignment of the cell contents.
 124      */
 125     [property] com::sun::star::table::CellVertJustify VertJustify;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** is <TRUE/>, if text in the cells will be wrapped automatically
 130         at the right border.
 131      */
 132     [property] boolean IsTextWrapped;
 133
 134     //-------------------------------------------------------------------------
 135
 136     /** defines the indentation of the cell contents (in 1/100 mm).
 137      */
 138     [property] short ParaIndent;
 139
 140     //-------------------------------------------------------------------------
 141
 142     /** contains the orientation of the cell contents.
 143
 144         <p>If the <member>CellProperties::RotateAngle</member> property
 145         is non-zero, this value is not used.</p>
 146      */
 147     [property] com::sun::star::table::CellOrientation Orientation;
 148
 149     //-------------------------------------------------------------------------
 150
 151     /** defines how much the content of cells is rotated (in 1/100 degrees).
 152      */
 153     [property] long RotateAngle;
 154
 155     //-------------------------------------------------------------------------
 156
 157     /** defines at which edge rotated cells are aligned.
 158      */
 159     [property] com::sun::star::table::CellVertJustify RotateReference;
 160
 161     //-------------------------------------------------------------------------
 162
 163     /** selects Asian character orientation in vertical orientation.
 164
 165         <p>If the <member>CellProperties::Orientation</member> property is
 166         <const>CellOrientation::STACKED</const>, in Asian mode only Asian
 167         characters are printed in horizontal orientation instead of all
 168         characters.
 169         For other values of <member>CellProperties::Orientation</member>,
 170         this value is not used.</p>
 171      */
 172     [optional, property] boolean AsianVerticalMode;
 173
 174     //-------------------------------------------------------------------------
 175
 176     /** contains a description of the cell or cell range border.
 177
 178         <p>If used with a cell range, the top, left, right, and bottom
 179         lines are at the edges of the entire range, not at the edges of
 180         the individual cell.</p>
 181      */
 182     [property] com::sun::star::table::TableBorder TableBorder;
 183
 184     //-------------------------------------------------------------------------
 185
 186     /** contains a description of the top border line of each cell.
 187      */
 188     [property] com::sun::star::table::BorderLine TopBorder;
 189
 190     //-------------------------------------------------------------------------
 191
 192     /** contains a description of the bottom border line of each cell.
 193     */
 194     [property] com::sun::star::table::BorderLine BottomBorder;
 195
 196     //-------------------------------------------------------------------------
 197
 198     /** contains a description of the left border line of each cell.
 199      */
 200     [property] com::sun::star::table::BorderLine LeftBorder;
 201
 202     //-------------------------------------------------------------------------
 203
 204     /** contains a description of the right border line of each cell.
 205      */
 206     [property] com::sun::star::table::BorderLine RightBorder;
 207
 208     //-------------------------------------------------------------------------
 209
 210     /** contains the index of the number format that is used in the cells.
 211
 212         <p>The proper value can be determined by using the
 213         <type scope="com::sun::star::util">NumberFormatter</type>
 214         interface of the document.</p>
 215      */
 216     [property] long NumberFormat;
 217
 218     //-------------------------------------------------------------------------
 219
 220     /** contains a description of the shadow.
 221      */
 222     [property] com::sun::star::table::ShadowFormat ShadowFormat;
 223
 224     //-------------------------------------------------------------------------
 225
 226     /** contains a description of the cell protection.
 227
 228         <p>Cell protection is active only if the sheet is protected.</p>
 229      */
 230     [property] com::sun::star::util::CellProtection CellProtection;
 231
 232     //-------------------------------------------------------------------------
 233
 234     /** stores additional attributes.
 235
 236         <p>This property is used i.e. by the XML filters to load and
 237         restore unknown attributes.</p>
 238         */
 239     [optional, property] com::sun::star::container::XNameContainer
 240         UserDefinedAttributes;
 241
 242     //-------------------------------------------------------------------------
 243
 244     /** contains a description of the top left to bottom right diagonal line of each cell.
 245      */
 246     [optional, property] com::sun::star::table::BorderLine DiagonalTLBR;
 247
 248     //-------------------------------------------------------------------------
 249
 250     /** contains a description of the bottom left to top right diagonal line of each cell.
 251      */
 252     [optional, property] com::sun::star::table::BorderLine DiagonalBLTR;
 253
 254     //-------------------------------------------------------------------------
 255
 256     /** is <TRUE/>, if the cell content will be shrinked to fit in the cell.
 257      */
 258     [optional, property] boolean ShrinkToFit;
 259
 260     //-------------------------------------------------------------------------
 261 };
 262
 263 //=============================================================================
 264
 265 }; }; }; };
 266
 267 #endif
 268