offapi/com/sun/star/sheet/TableAutoFormatField.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: TableAutoFormatField.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
  31 #ifndef __com_sun_star_sheet_TableAutoFormatField_idl__
  32 #define __com_sun_star_sheet_TableAutoFormatField_idl__
  33
  34 #ifndef __com_sun_star_beans_XPropertySet_idl__
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_Color_idl__
  39 #include <com/sun/star/util/Color.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_Locale_idl__
  43 #include <com/sun/star/lang/Locale.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_awt_FontSlant_idl__
  47 #include <com/sun/star/awt/FontSlant.idl>
  48 #endif
  49
  50 #ifndef __com_sun_star_table_ShadowFormat_idl__
  51 #include <com/sun/star/table/ShadowFormat.idl>
  52 #endif
  53
  54 #ifndef __com_sun_star_table_CellHoriJustify_idl__
  55 #include <com/sun/star/table/CellHoriJustify.idl>
  56 #endif
  57
  58 #ifndef __com_sun_star_table_CellVertJustify_idl__
  59 #include <com/sun/star/table/CellVertJustify.idl>
  60 #endif
  61
  62 #ifndef __com_sun_star_table_CellOrientation_idl__
  63 #include <com/sun/star/table/CellOrientation.idl>
  64 #endif
  65
  66 #ifndef __com_sun_star_table_TableBorder_idl__
  67 #include <com/sun/star/table/TableBorder.idl>
  68 #endif
  69
  70 //=============================================================================
  71
  72 module com {  module sun {  module star {  module sheet {
  73
  74 //=============================================================================
  75
  76 /** represents a field in an AutoFormat. A field contains all cell
  77     properties for a specific position in an AutoFormat.
  78  */
  79 published service TableAutoFormatField
  80 {
  81     //-------------------------------------------------------------------------
  82
  83 //!     service com::sun::star::beans::PropertySet;
  84     /** provides access to the properties.
  85      */
  86     interface com::sun::star::beans::XPropertySet;
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** specifies the name of the western font.
  91      */
  92     [property] string CharFontName;
  93
  94     /** specifies the name of the asian font.
  95      */
  96     [optional, property] string CharFontNameAsian;
  97
  98     /** specifies the name of the complex font.
  99      */
 100     [optional, property] string CharFontNameComplex;
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** specifies the name of the western font style.
 105      */
 106     [property] string CharFontStyleName;
 107
 108     /** specifies the name of the asian font style.
 109      */
 110     [optional, property] string CharFontStyleNameAsian;
 111
 112     /** specifies the name of the complex font style.
 113      */
 114     [optional, property] string CharFontStyleNameComplex;
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** contains the value of the character set of the western font.
 119      */
 120     [property] string CharFontCharSet;
 121
 122     /** contains the value of the character set of the asian font.
 123      */
 124     [optional, property] string CharFontCharSetAsian;
 125
 126     /** contains the value of the character set of the complex font.
 127      */
 128     [optional, property] string CharFontCharSetComplex;
 129
 130     //-------------------------------------------------------------------------
 131
 132     /** contains the value of the western font family.
 133      */
 134     [property] string CharFontFamily;
 135
 136     /** contains the value of the asian font family.
 137      */
 138     [optional, property] string CharFontFamilyAsian;
 139
 140     /** contains the value of the complex font family.
 141      */
 142     [optional, property] string CharFontFamilyComplex;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** contains the value of the pitch of the western font.
 147      */
 148     [property] string CharFontPitch;
 149
 150     /** contains the value of the pitch of the asian font.
 151      */
 152     [optional, property] string CharFontPitchAsian;
 153
 154     /** contains the value of the pitch of the complex font.
 155      */
 156     [optional, property] string CharFontPitchComplex;
 157
 158     //-------------------------------------------------------------------------
 159
 160     /** contains the height of characters of the western font in point.
 161      */
 162     [property] float CharHeight;
 163
 164     /** contains the height of characters of the asian font in point.
 165      */
 166     [optional, property] float CharHeightAsian;
 167
 168     /** contains the height of characters of the complex font in point.
 169      */
 170     [optional, property] float CharHeightComplex;
 171
 172     //-------------------------------------------------------------------------
 173
 174     /** contains the value for the weight of characters of the western font.
 175      */
 176     [property] float CharWeight;
 177
 178     /** contains the value for the weight of characters of the asian font.
 179      */
 180     [optional, property] float CharWeightAsian;
 181
 182     /** contains the value for the weight of characters of the complex font.
 183      */
 184     [optional, property] float CharWeightComplex;
 185
 186     //-------------------------------------------------------------------------
 187
 188     /** contains the value of the posture of characters of the western font.
 189      */
 190     [property] com::sun::star::awt::FontSlant CharPosture;
 191
 192     /** contains the value of the posture of characters of the asian font.
 193      */
 194     [optional, property] com::sun::star::awt::FontSlant CharPostureAsian;
 195
 196     /** contains the value of the posture of characters of the comlex font.
 197      */
 198     [optional, property] com::sun::star::awt::FontSlant CharPostureComplex;
 199
 200     //-------------------------------------------------------------------------
 201
 202     /** contains the value for the character underline.
 203      */
 204     [property] short CharUnderline;
 205
 206     //-------------------------------------------------------------------------
 207
 208     /** is <TRUE/> if the characters are crossed out.
 209      */
 210     [property] boolean CharCrossedOut;
 211
 212     //-------------------------------------------------------------------------
 213
 214     /** is <TRUE/> if the characters are contoured.
 215      */
 216     [property] boolean CharContoured;
 217
 218     //-------------------------------------------------------------------------
 219
 220     /** is <TRUE/> if the characters are shadowed.
 221      */
 222     [property] boolean CharShadowed;
 223
 224     //-------------------------------------------------------------------------
 225
 226     /** contains the value of the text color.
 227      */
 228     [property] com::sun::star::util::Color CharColor;
 229
 230     //-------------------------------------------------------------------------
 231
 232     /** contains the cell background color.
 233      */
 234     [property] com::sun::star::util::Color CellBackColor;
 235
 236     //-------------------------------------------------------------------------
 237
 238     /** is <TRUE/> if the cell background is transparent.
 239
 240         <p>In this case the <member>TableAutoFormatField::CellBackColor</member>
 241         value is not used.</p>
 242      */
 243     [property] boolean IsCellBackgroundTransparent;
 244
 245     //-------------------------------------------------------------------------
 246
 247     /** contains a description of the shadow.
 248      */
 249     [optional, property] com::sun::star::table::ShadowFormat ShadowFormat;
 250
 251     //-------------------------------------------------------------------------
 252
 253     /** specifies the horizontal alignment of the cell contents.
 254      */
 255     [optional, property] com::sun::star::table::CellHoriJustify HoriJustify;
 256
 257     //-------------------------------------------------------------------------
 258
 259     /** specifies the vertical alignment of the cell contents.
 260      */
 261     [optional, property] com::sun::star::table::CellVertJustify VertJustify;
 262
 263     //-------------------------------------------------------------------------
 264
 265     /** is <TRUE/> if text breaks automatically at cell borders.
 266      */
 267     [optional, property] boolean IsTextWrapped;
 268
 269     //-------------------------------------------------------------------------
 270
 271     /** contains the orientation of the cell contents
 272         (i.e. top-to-bottom or stacked).
 273      */
 274     [optional, property] com::sun::star::table::CellOrientation Orientation;
 275
 276     //-------------------------------------------------------------------------
 277
 278     /** contains the rotation angle of the cell contents.
 279      */
 280     [optional, property] long RotateAngle;
 281
 282     //-------------------------------------------------------------------------
 283
 284     /** contains the reference egde of the cell rotation.
 285      */
 286     [optional, property] com::sun::star::table::CellVertJustify RotateReference;
 287
 288     //-------------------------------------------------------------------------
 289
 290     /** contains the margin between cell contents and top border
 291         (in 1/100 mm).
 292      */
 293     [optional, property] long ParaTopMargin;
 294
 295     //-------------------------------------------------------------------------
 296
 297     /** contains the margin between cell contents and bottom border
 298         (in 1/100 mm).
 299      */
 300     [optional, property] long ParaBottomMargin;
 301
 302     //-------------------------------------------------------------------------
 303
 304     /** contains the margin between cell contents and left border
 305         (in 1/100 mm).
 306      */
 307     [optional, property] long ParaLeftMargin;
 308
 309     //-------------------------------------------------------------------------
 310
 311     /** contains the margin between cell contents and right border
 312         (in 1/100 mm).
 313      */
 314     [optional, property] long ParaRightMargin;
 315
 316     //-------------------------------------------------------------------------
 317
 318     /** property containing a description of the cell border.
 319
 320         @since OOo 1.1.2
 321      */
 322     [optional, property] com::sun::star::table::TableBorder TableBorder;
 323 };
 324
 325 //=============================================================================
 326
 327 }; }; }; };
 328
 329 //=============================================================================
 330
 331 #endif
 332