1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_CellProperties_idl__
24#define __com_sun_star_text_CellProperties_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30#ifndef __com_sun_star_util_Color_idl__
31#include <com/sun/star/util/Color.idl>
32#endif
33
34#ifndef __com_sun_star_text_XTextSection_idl__
35#include <com/sun/star/text/XTextSection.idl>
36#endif
37#ifndef __com_sun_star_style_GraphicLocation_idl__
38#include <com/sun/star/style/GraphicLocation.idl>
39#endif
40#ifndef __com_sun_star_table_BorderLine_idl__
41#include <com/sun/star/table/BorderLine.idl>
42#endif
43#ifndef __com_sun_star_container_XNameContainer_idl__
44#include <com/sun/star/container/XNameContainer.idl>
45#endif
46#ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
47#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
48#endif
49
50
51//=============================================================================
52
53 module com {  module sun {  module star {  module text {
54
55//=============================================================================
56
57/** service that holds all cell properties of a text table cell in a text document.
58
59    @see com::sun::star::text::Cell
60 */
61published service CellProperties
62{
63    //-------------------------------------------------------------------------
64    /** contains user defined attributes.
65
66        @see    <type scope="com::sun::star::xml">UserDefinedAttributesSupplier</type>
67     */
68    service com::sun::star::xml::UserDefinedAttributesSupplier;
69
70    //-------------------------------------------------------------------------
71
72    /** gives access to the objects properties
73     */
74    interface com::sun::star::beans::XPropertySet;
75
76    //-------------------------------------------------------------------------
77    /** contains the cell name, see SwXTextTable::getCellByName for more information
78	 */
79    [property] string CellName;
80
81    //-------------------------------------------------------------------------
82    /** contains the background color.
83	 */
84    [property] com::sun::star::util::Color BackColor;
85
86    //-------------------------------------------------------------------------
87    /** contains the URL to the background graphic.
88	 */
89    [property] string BackGraphicURL;
90
91    //-------------------------------------------------------------------------
92    /** contains the name of the graphic filter of the background graphic.
93	 */
94    [property] string BackGraphicFilter;
95
96    //-------------------------------------------------------------------------
97    /** determins the position of the background graphic.
98	 */
99    [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
100
101    //-------------------------------------------------------------------------
102    /** contains the number format.
103     */
104    [property] long NumberFormat;
105
106    //-------------------------------------------------------------------------
107    /** determins whether the background is transparent.
108     */
109    [property] boolean BackTransparent;
110
111    //-------------------------------------------------------------------------
112    /** contains the left border line.
113     */
114    [property] com::sun::star::table::BorderLine LeftBorder;
115
116    //-------------------------------------------------------------------------
117    /** contains the right border line.
118     */
119    [property] com::sun::star::table::BorderLine RightBorder;
120
121    //-------------------------------------------------------------------------
122    /** contains the top border line.
123     */
124    [property] com::sun::star::table::BorderLine TopBorder;
125
126    //-------------------------------------------------------------------------
127    /** contains the bottom border line.
128	 */
129    [property] com::sun::star::table::BorderLine BottomBorder;
130
131    //-------------------------------------------------------------------------
132    /** contains the distance of the left border.
133     */
134    [property] long LeftBorderDistance;
135
136    //-------------------------------------------------------------------------
137    /** contains the distance of the right border.
138     */
139    [property] long RightBorderDistance;
140
141    //-------------------------------------------------------------------------
142    /** contains the distance of the top border.
143     */
144    [property] long TopBorderDistance;
145
146    //-------------------------------------------------------------------------
147    /** contains the distance of the bottom border.
148	 */
149    [property] long BottomBorderDistance;
150
151    //-------------------------------------------------------------------------
152    /** contains the text section the text table is contained in if there is any.
153	 */
154    [readonly, property]com::sun::star::text::XTextSection TextSection;
155
156    //-------------------------------------------------------------------------
157    /** determins whether the cell is write protected or not.
158	 */
159    [property] boolean IsProtected;
160
161	//-------------------------------------------------------------------------
162	/** the vertical orientation of the text inside of the table cells in
163		this row.@see VertOrientation
164	 */
165	[property] short VertOrient;
166
167};
168
169//=============================================================================
170
171}; }; }; };
172#endif
173