offapi/com/sun/star/text/CellProperties.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 module com {  module sun {  module star {  module text {
  21
  22 /** service that holds all cell properties of a text table cell in a text document.
  23
  24     @see com::sun::star::text::Cell
  25  */
  26 published service CellProperties
  27 {
  28     /** contains user defined attributes.
  29
  30         @see    com::sun::star::xml::UserDefinedAttributesSupplier
  31      */
  32     service com::sun::star::xml::UserDefinedAttributesSupplier;
  33
  34
  35     /** gives access to the objects properties
  36      */
  37     interface com::sun::star::beans::XPropertySet;
  38
  39     /** contains the cell name, see SwXTextTable::getCellByName for more information
  40      */
  41     [property] string CellName;
  42
  43     /** contains the background color.
  44      */
  45     [property] com::sun::star::util::Color BackColor;
  46
  47     /** contains the URL to the background graphic.
  48
  49         @deprecated as of LibreOffice 6.1 - use BackGraphic instead
  50
  51         Note the new behaviour since it this was deprecated:
  52         This property can only be set and only external URLs are
  53         supported (no more vnd.sun.star.GraphicObject scheme). When an
  54         URL is set, then it will load the graphic and set the BackGraphic
  55         property.
  56      */
  57     [property] string BackGraphicURL;
  58
  59     /** contains the name of the graphic filter of the background graphic.
  60      */
  61     [property] string BackGraphicFilter;
  62
  63     /** determines the position of the background graphic.
  64      */
  65     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
  66
  67     /** contains the number format.
  68      */
  69     [property] long NumberFormat;
  70
  71     /** determines whether the background is transparent.
  72      */
  73     [property] boolean BackTransparent;
  74
  75     /** contains the left border line.
  76      */
  77     [property] com::sun::star::table::BorderLine LeftBorder;
  78
  79     /** contains the right border line.
  80      */
  81     [property] com::sun::star::table::BorderLine RightBorder;
  82
  83     /** contains the top border line.
  84      */
  85     [property] com::sun::star::table::BorderLine TopBorder;
  86
  87     /** contains the bottom border line.
  88      */
  89     [property] com::sun::star::table::BorderLine BottomBorder;
  90
  91     /** contains the distance of the left border.
  92      */
  93     [property] long LeftBorderDistance;
  94
  95     /** contains the distance of the right border.
  96      */
  97     [property] long RightBorderDistance;
  98
  99     /** contains the distance of the top border.
 100      */
 101     [property] long TopBorderDistance;
 102
 103     /** contains the distance of the bottom border.
 104      */
 105     [property] long BottomBorderDistance;
 106
 107     /** contains the text section the text table is contained in if there is any.
 108      */
 109     [readonly, property]com::sun::star::text::XTextSection TextSection;
 110
 111     /** determines whether the cell is write protected or not.
 112      */
 113     [property] boolean IsProtected;
 114
 115     /** the vertical orientation of the text inside of the table cells in
 116         this row.@see VertOrientation
 117      */
 118     [property] short VertOrient;
 119
 120     /** contains the graphic object that is displayed as background graphic.
 121
 122         @since LibreOffice 6.1
 123      */
 124     [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
 125
 126     /** Parent text of this table cell.
 127
 128         This might be a header text, body text, parent cell, etc.
 129
 130         @since LibreOffice 6.3
 131      */
 132     [optional, readonly, property] com::sun::star::text::XText ParentText;
 133
 134     /** If TRUE, the table cell wasn't deleted or inserted with its tracked cell content
 135
 136         @since LibreOffice 7.6
 137      */
 138     [optional, property] boolean HasTextChangesOnly;
 139 };
 140
 141
 142 }; }; }; };
 143
 144 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */