offapi/com/sun/star/sheet/TableAutoFormatField.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
  20
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a field in an AutoFormat. A field contains all cell
  25     properties for a specific position in an AutoFormat.
  26  */
  27 published service TableAutoFormatField
  28 {
  29
  30 //! service com::sun::star::beans::PropertySet;
  31     /** provides access to the properties.
  32      */
  33     interface com::sun::star::beans::XPropertySet;
  34
  35
  36     /** specifies the name of the western font.
  37      */
  38     [property] string CharFontName;
  39
  40     /** specifies the name of the Asian font.
  41      */
  42     [optional, property] string CharFontNameAsian;
  43
  44     /** specifies the name of the complex font.
  45      */
  46     [optional, property] string CharFontNameComplex;
  47
  48
  49     /** specifies the name of the western font style.
  50      */
  51     [property] string CharFontStyleName;
  52
  53     /** specifies the name of the Asian font style.
  54      */
  55     [optional, property] string CharFontStyleNameAsian;
  56
  57     /** specifies the name of the complex font style.
  58      */
  59     [optional, property] string CharFontStyleNameComplex;
  60
  61
  62     /** contains the value of the character set of the western font.
  63      */
  64     [property] string CharFontCharSet;
  65
  66     /** contains the value of the character set of the Asian font.
  67      */
  68     [optional, property] string CharFontCharSetAsian;
  69
  70     /** contains the value of the character set of the complex font.
  71      */
  72     [optional, property] string CharFontCharSetComplex;
  73
  74
  75     /** contains the value of the western font family.
  76      */
  77     [property] string CharFontFamily;
  78
  79     /** contains the value of the Asian font family.
  80      */
  81     [optional, property] string CharFontFamilyAsian;
  82
  83     /** contains the value of the complex font family.
  84      */
  85     [optional, property] string CharFontFamilyComplex;
  86
  87
  88     /** contains the value of the pitch of the western font.
  89      */
  90     [property] string CharFontPitch;
  91
  92     /** contains the value of the pitch of the Asian font.
  93      */
  94     [optional, property] string CharFontPitchAsian;
  95
  96     /** contains the value of the pitch of the complex font.
  97      */
  98     [optional, property] string CharFontPitchComplex;
  99
 100
 101     /** contains the height of characters of the western font in point.
 102      */
 103     [property] float CharHeight;
 104
 105     /** contains the height of characters of the Asian font in point.
 106      */
 107     [optional, property] float CharHeightAsian;
 108
 109     /** contains the height of characters of the complex font in point.
 110      */
 111     [optional, property] float CharHeightComplex;
 112
 113
 114     /** contains the value for the weight of characters of the western font.
 115      */
 116     [property] float CharWeight;
 117
 118     /** contains the value for the weight of characters of the Asian font.
 119      */
 120     [optional, property] float CharWeightAsian;
 121
 122     /** contains the value for the weight of characters of the complex font.
 123      */
 124     [optional, property] float CharWeightComplex;
 125
 126
 127     /** contains the value of the posture of characters of the western font.
 128      */
 129     [property] com::sun::star::awt::FontSlant CharPosture;
 130
 131     /** contains the value of the posture of characters of the Asian font.
 132      */
 133     [optional, property] com::sun::star::awt::FontSlant CharPostureAsian;
 134
 135     /** contains the value of the posture of characters of the complex font.
 136      */
 137     [optional, property] com::sun::star::awt::FontSlant CharPostureComplex;
 138
 139
 140     /** contains the value for the character underline.
 141      */
 142     [property] short CharUnderline;
 143
 144
 145     /** is `TRUE` if the characters are crossed out.
 146      */
 147     [property] boolean CharCrossedOut;
 148
 149
 150     /** is `TRUE` if the characters are contoured.
 151      */
 152     [property] boolean CharContoured;
 153
 154
 155     /** is `TRUE` if the characters are shadowed.
 156      */
 157     [property] boolean CharShadowed;
 158
 159
 160     /** contains the value of the text color.
 161      */
 162     [property] com::sun::star::util::Color CharColor;
 163
 164
 165     /** contains the cell background color.
 166      */
 167     [property] com::sun::star::util::Color CellBackColor;
 168
 169
 170     /** is `TRUE` if the cell background is transparent.
 171
 172         <p>In this case the TableAutoFormatField::CellBackColor
 173         value is not used.</p>
 174      */
 175     [property] boolean IsCellBackgroundTransparent;
 176
 177
 178     /** contains a description of the shadow.
 179      */
 180     [optional, property] com::sun::star::table::ShadowFormat ShadowFormat;
 181
 182
 183     /** specifies the horizontal alignment of the cell contents.
 184      */
 185     [optional, property] com::sun::star::table::CellHoriJustify HoriJustify;
 186
 187
 188     /** specifies the vertical alignment of the cell contents.
 189
 190         changed from com::sun::star::table::CellVertJustify to long in LibO 3.5
 191
 192         @see com::sun::star::table::CellVertJustify2
 193      */
 194     [optional, property] long VertJustify;
 195
 196
 197     /** is `TRUE` if text breaks automatically at cell borders.
 198      */
 199     [optional, property] boolean IsTextWrapped;
 200
 201
 202     /** contains the orientation of the cell contents
 203         (i.e. top-to-bottom or stacked).
 204      */
 205     [optional, property] com::sun::star::table::CellOrientation Orientation;
 206
 207
 208     /** contains the rotation angle of the cell contents.
 209      */
 210     [optional, property] long RotateAngle;
 211
 212
 213     /** contains the reference edge of the cell rotation.
 214
 215         changed from com::sun::star::table::CellVertJustify to long in LibO 3.5
 216
 217         @see com::sun::star::table::CellVertJustify2
 218      */
 219     [optional, property] long RotateReference;
 220
 221
 222     /** contains the margin between cell contents and top border
 223         (in 1/100 mm).
 224      */
 225     [optional, property] long ParaTopMargin;
 226
 227
 228     /** contains the margin between cell contents and bottom border
 229         (in 1/100 mm).
 230      */
 231     [optional, property] long ParaBottomMargin;
 232
 233
 234     /** contains the margin between cell contents and left border
 235         (in 1/100 mm).
 236      */
 237     [optional, property] long ParaLeftMargin;
 238
 239
 240     /** contains the margin between cell contents and right border
 241         (in 1/100 mm).
 242      */
 243     [optional, property] long ParaRightMargin;
 244
 245
 246     /** property containing a description of the cell border.
 247
 248         @since OOo 1.1.2
 249      */
 250     [optional, property] com::sun::star::table::TableBorder TableBorder;
 251
 252
 253     /** property containing a description of the cell border.
 254         Preferred over com::sun::star::table::TableBorder
 255         #TableBorder.
 256
 257         @since LibreOffice 3.6
 258      */
 259     [optional, property] com::sun::star::table::TableBorder2 TableBorder2;
 260 };
 261
 262
 263 }; }; }; };
 264
 265
 266 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */