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