1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_CellProperties_idl__
28#define __com_sun_star_text_CellProperties_idl__
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33
34#ifndef __com_sun_star_util_Color_idl__
35#include <com/sun/star/util/Color.idl>
36#endif
37
38#ifndef __com_sun_star_text_XTextSection_idl__
39#include <com/sun/star/text/XTextSection.idl>
40#endif
41#ifndef __com_sun_star_style_GraphicLocation_idl__
42#include <com/sun/star/style/GraphicLocation.idl>
43#endif
44#ifndef __com_sun_star_table_BorderLine_idl__
45#include <com/sun/star/table/BorderLine.idl>
46#endif
47#ifndef __com_sun_star_container_XNameContainer_idl__
48#include <com/sun/star/container/XNameContainer.idl>
49#endif
50#ifndef _com_sun_star_xml_UserDefinedAttributesSupplier_idl_
51#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
52#endif
53
54
55//=============================================================================
56
57 module com {  module sun {  module star {  module text {
58
59//=============================================================================
60
61/** service that holds all cell properties of a text table cell in a text document.
62
63    @see com::sun::star::text::Cell
64 */
65published service CellProperties
66{
67    //-------------------------------------------------------------------------
68    /** contains user defined attributes.
69
70        @see    <type scope="com::sun::star::xml">UserDefinedAttributesSupplier</type>
71     */
72    service com::sun::star::xml::UserDefinedAttributesSupplier;
73
74    //-------------------------------------------------------------------------
75
76    /** gives access to the objects properties
77     */
78    interface com::sun::star::beans::XPropertySet;
79
80    //-------------------------------------------------------------------------
81    /** contains the cell name, see SwXTextTable::getCellByName for more information
82	 */
83    [property] string CellName;
84
85    //-------------------------------------------------------------------------
86    /** contains the background color.
87	 */
88    [property] com::sun::star::util::Color BackColor;
89
90    //-------------------------------------------------------------------------
91    /** contains the URL to the background graphic.
92	 */
93    [property] string BackGraphicURL;
94
95    //-------------------------------------------------------------------------
96    /** contains the name of the graphic filter of the background graphic.
97	 */
98    [property] string BackGraphicFilter;
99
100    //-------------------------------------------------------------------------
101    /** determins the position of the background graphic.
102	 */
103    [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
104
105    //-------------------------------------------------------------------------
106    /** contains the number format.
107     */
108    [property] long NumberFormat;
109
110    //-------------------------------------------------------------------------
111    /** determins whether the background is transparent.
112     */
113    [property] boolean BackTransparent;
114
115    //-------------------------------------------------------------------------
116    /** contains the left border line.
117     */
118    [property] com::sun::star::table::BorderLine LeftBorder;
119
120    //-------------------------------------------------------------------------
121    /** contains the right border line.
122     */
123    [property] com::sun::star::table::BorderLine RightBorder;
124
125    //-------------------------------------------------------------------------
126    /** contains the top border line.
127     */
128    [property] com::sun::star::table::BorderLine TopBorder;
129
130    //-------------------------------------------------------------------------
131    /** contains the bottom border line.
132	 */
133    [property] com::sun::star::table::BorderLine BottomBorder;
134
135    //-------------------------------------------------------------------------
136    /** contains the distance of the left border.
137     */
138    [property] long LeftBorderDistance;
139
140    //-------------------------------------------------------------------------
141    /** contains the distance of the right border.
142     */
143    [property] long RightBorderDistance;
144
145    //-------------------------------------------------------------------------
146    /** contains the distance of the top border.
147     */
148    [property] long TopBorderDistance;
149
150    //-------------------------------------------------------------------------
151    /** contains the distance of the bottom border.
152	 */
153    [property] long BottomBorderDistance;
154
155    //-------------------------------------------------------------------------
156    /** contains the text section the text table is contained in if there is any.
157	 */
158    [readonly, property]com::sun::star::text::XTextSection TextSection;
159
160    //-------------------------------------------------------------------------
161    /** determins whether the cell is write protected or not.
162	 */
163    [property] boolean IsProtected;
164
165	//-------------------------------------------------------------------------
166	/** the vertical orientation of the text inside of the table cells in
167		this row.@see VertOrientation
168	 */
169	[property] short VertOrient;
170
171};
172
173//=============================================================================
174
175}; }; }; };
176#endif
177