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 #ifndef __com_sun_star_text_CellProperties_idl__
  20 #define __com_sun_star_text_CellProperties_idl__
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23 #include <com/sun/star/util/Color.idl>
  24 #include <com/sun/star/text/XTextSection.idl>
  25 #include <com/sun/star/style/GraphicLocation.idl>
  26 #include <com/sun/star/table/BorderLine.idl>
  27 #include <com/sun/star/container/XNameContainer.idl>
  28 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
  29
  30
  31
  32  module com {  module sun {  module star {  module text {
  33
  34
  35 /** service that holds all cell properties of a text table cell in a text document.
  36
  37     @see com::sun::star::text::Cell
  38  */
  39 published service CellProperties
  40 {
  41     /** contains user defined attributes.
  42
  43         @see    com::sun::star::xml::UserDefinedAttributesSupplier
  44      */
  45     service com::sun::star::xml::UserDefinedAttributesSupplier;
  46
  47
  48     /** gives access to the objects properties
  49      */
  50     interface com::sun::star::beans::XPropertySet;
  51
  52     /** contains the cell name, see SwXTextTable::getCellByName for more information
  53      */
  54     [property] string CellName;
  55
  56     /** contains the background color.
  57      */
  58     [property] com::sun::star::util::Color BackColor;
  59
  60     /** contains the URL to the background graphic.
  61      */
  62     [property] string BackGraphicURL;
  63
  64     /** contains the name of the graphic filter of the background graphic.
  65      */
  66     [property] string BackGraphicFilter;
  67
  68     /** determines the position of the background graphic.
  69      */
  70     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
  71
  72     /** contains the number format.
  73      */
  74     [property] long NumberFormat;
  75
  76     /** determines whether the background is transparent.
  77      */
  78     [property] boolean BackTransparent;
  79
  80     /** contains the left border line.
  81      */
  82     [property] com::sun::star::table::BorderLine LeftBorder;
  83
  84     /** contains the right border line.
  85      */
  86     [property] com::sun::star::table::BorderLine RightBorder;
  87
  88     /** contains the top border line.
  89      */
  90     [property] com::sun::star::table::BorderLine TopBorder;
  91
  92     /** contains the bottom border line.
  93      */
  94     [property] com::sun::star::table::BorderLine BottomBorder;
  95
  96     /** contains the distance of the left border.
  97      */
  98     [property] long LeftBorderDistance;
  99
 100     /** contains the distance of the right border.
 101      */
 102     [property] long RightBorderDistance;
 103
 104     /** contains the distance of the top border.
 105      */
 106     [property] long TopBorderDistance;
 107
 108     /** contains the distance of the bottom border.
 109      */
 110     [property] long BottomBorderDistance;
 111
 112     /** contains the text section the text table is contained in if there is any.
 113      */
 114     [readonly, property]com::sun::star::text::XTextSection TextSection;
 115
 116     /** determines whether the cell is write protected or not.
 117      */
 118     [property] boolean IsProtected;
 119
 120     /** the vertical orientation of the text inside of the table cells in
 121         this row.@see VertOrientation
 122      */
 123     [property] short VertOrient;
 124
 125 };
 126
 127
 128 }; }; }; };
 129 #endif
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */