offapi/com/sun/star/text/CellProperties.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: CellProperties.idl,v $
  10  * $Revision: 1.15 $
  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 #ifndef __com_sun_star_text_CellProperties_idl__
  31 #define __com_sun_star_text_CellProperties_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_text_XTextSection_idl__
  42 #include <com/sun/star/text/XTextSection.idl>
  43 #endif
  44 #ifndef __com_sun_star_style_GraphicLocation_idl__
  45 #include <com/sun/star/style/GraphicLocation.idl>
  46 #endif
  47 #ifndef __com_sun_star_table_BorderLine_idl__
  48 #include <com/sun/star/table/BorderLine.idl>
  49 #endif
  50 #ifndef __com_sun_star_container_XNameContainer_idl__
  51 #include <com/sun/star/container/XNameContainer.idl>
  52 #endif
  53 #ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
  54 #include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
  55 #endif
  56
  57
  58 //=============================================================================
  59
  60  module com {  module sun {  module star {  module text {
  61
  62 //=============================================================================
  63
  64 /** service that holds all cell properties of a text table cell in a text document.
  65
  66     @see com::sun::star::text::Cell
  67  */
  68 published service CellProperties
  69 {
  70     //-------------------------------------------------------------------------
  71     /** contains user defined attributes.
  72
  73         @see    <type scope="com::sun::star::xml">UserDefinedAttributesSupplier</type>
  74      */
  75     service com::sun::star::xml::UserDefinedAttributesSupplier;
  76
  77     //-------------------------------------------------------------------------
  78
  79     /** gives access to the objects properties
  80      */
  81     interface com::sun::star::beans::XPropertySet;
  82
  83     //-------------------------------------------------------------------------
  84     /** contains the cell name, see SwXTextTable::getCellByName for more information
  85      */
  86     [property] string CellName;
  87
  88     //-------------------------------------------------------------------------
  89     /** contains the background color.
  90      */
  91     [property] com::sun::star::util::Color BackColor;
  92
  93     //-------------------------------------------------------------------------
  94     /** contains the URL to the background graphic.
  95      */
  96     [property] string BackGraphicURL;
  97
  98     //-------------------------------------------------------------------------
  99     /** contains the name of the graphic filter of the background graphic.
 100      */
 101     [property] string BackGraphicFilter;
 102
 103     //-------------------------------------------------------------------------
 104     /** determins the position of the background graphic.
 105      */
 106     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
 107
 108     //-------------------------------------------------------------------------
 109     /** contains the number format.
 110      */
 111     [property] long NumberFormat;
 112
 113     //-------------------------------------------------------------------------
 114     /** determins whether the background is transparent.
 115      */
 116     [property] boolean BackTransparent;
 117
 118     //-------------------------------------------------------------------------
 119     /** contains the left border line.
 120      */
 121     [property] com::sun::star::table::BorderLine LeftBorder;
 122
 123     //-------------------------------------------------------------------------
 124     /** contains the right border line.
 125      */
 126     [property] com::sun::star::table::BorderLine RightBorder;
 127
 128     //-------------------------------------------------------------------------
 129     /** contains the top border line.
 130      */
 131     [property] com::sun::star::table::BorderLine TopBorder;
 132
 133     //-------------------------------------------------------------------------
 134     /** contains the bottom border line.
 135      */
 136     [property] com::sun::star::table::BorderLine BottomBorder;
 137
 138     //-------------------------------------------------------------------------
 139     /** contains the distance of the left border.
 140      */
 141     [property] long LeftBorderDistance;
 142
 143     //-------------------------------------------------------------------------
 144     /** contains the distance of the right border.
 145      */
 146     [property] long RightBorderDistance;
 147
 148     //-------------------------------------------------------------------------
 149     /** contains the distance of the top border.
 150      */
 151     [property] long TopBorderDistance;
 152
 153     //-------------------------------------------------------------------------
 154     /** contains the distance of the bottom border.
 155      */
 156     [property] long BottomBorderDistance;
 157
 158     //-------------------------------------------------------------------------
 159     /** contains the text section the text table is contained in if there is any.
 160      */
 161     [readonly, property]com::sun::star::text::XTextSection TextSection;
 162
 163     //-------------------------------------------------------------------------
 164     /** determins whether the cell is write protected or not.
 165      */
 166     [property] boolean IsProtected;
 167
 168     //-------------------------------------------------------------------------
 169     /** the vertical orientation of the text inside of the table cells in
 170         this row.@see VertOrientation
 171      */
 172     [property] short VertOrient;
 173
 174 };
 175
 176 //=============================================================================
 177
 178 }; }; }; };
 179 #endif