summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/table/CellProperties.idl
blob: 199c5b508537391a07dd6591cdfc48e76a5bc02d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/*************************************************************************
 *
 *  $RCSfile: CellProperties.idl,v $
 *
 *  $Revision: 1.5 $
 *
 *  last change: $Author: mi $ $Date: 2000-12-21 08:35:19 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_table_CellProperties_idl__
#define __com_sun_star_table_CellProperties_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_table_ShadowFormat_idl__
#include <com/sun/star/table/ShadowFormat.idl>
#endif

#ifndef __com_sun_star_table_CellHoriJustify_idl__
#include <com/sun/star/table/CellHoriJustify.idl>
#endif

#ifndef __com_sun_star_table_CellVertJustify_idl__
#include <com/sun/star/table/CellVertJustify.idl>
#endif

#ifndef __com_sun_star_table_CellOrientation_idl__
#include <com/sun/star/table/CellOrientation.idl>
#endif

#ifndef __com_sun_star_util_CellProtection_idl__
#include <com/sun/star/util/CellProtection.idl>
#endif

#ifndef __com_sun_star_table_TableBorder_idl__
#include <com/sun/star/table/TableBorder.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module table {

//=============================================================================

// DocMerge from xml: service com::sun::star::table::CellProperties
/** service that holds all cell properties.@see Cell
 */
service CellProperties
{
    // DocMerge: empty anyway
    interface com::sun::star::beans::XPropertySet;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::CellStyle
    /** contains the name of the style of the cell.
     */
    [property] string CellStyle;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::CellBackColor
    /** contains the cell background color.
     */
    [property] long CellBackColor;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::IsCellBackgroundTransparent
    /** If this property is <TRUE/>, the cell background is transparent
        and the <member>CellProperties::CellBackColor</member> value is not used.
     */
    [property] boolean IsCellBackgroundTransparent;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::NumberFormat
    /** contains the index of the number format
        that is used in the cells.



        <p>The proper value can be determined by using the
        <type scope="com::sun::star::util">XNumberFormatter</type>
        interface of the document.</p>
     */
    [property] long NumberFormat;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::ShadowFormat
    /** contains a description of the shadow.
     */
    [property] com::sun::star::table::ShadowFormat ShadowFormat;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::HoriJustify
    /** property containing the horizontal alignment of
        text within the cells.
     */
    [property] com::sun::star::table::CellHoriJustify HoriJustify;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::VertJustify
    /** property containing the vertical alignment of
        text within the cells.
     */
    [property] com::sun::star::table::CellVertJustify VertJustify;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::Orientation
    /** property containing the orientation of text
        within the cells.



        <p>If the <member>CellProperties::RotateAngle</member> property is non-zero,
        this value is not used.</p>
     */
    [property] com::sun::star::table::CellOrientation Orientation;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::CellProtection
    /** contains a description of the cell
        protection.



        <p>Cell protection is active only if the sheet is
        protected.</p>
     */
    [property] com::sun::star::util::CellProtection CellProtection;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::TableBorder
    /** property containing a description of the cell border.



        <p>If used with a cell range, the top, left, right
        and bottom lines are at the edges of the entire range,
        not at the edges of the individual cell.</p>
     */
    [property] com::sun::star::table::TableBorder TableBorder;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::IsTextWrapped
    /** property <TRUE/> if text in the cells is wrapped.
     */
    [property] boolean IsTextWrapped;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::RotateAngle
    /** defines how much the content of cells
        is rotated (1/100th degrees).
     */
    [property] long RotateAngle;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::table::CellProperties::RotateReference
    /** defines at which edge rotated cells are aligned.
     */
    [property] com::sun::star::table::CellVertJustify RotateReference;

};

//=============================================================================

}; }; }; };

/*=============================================================================

    $Log: not supported by cvs2svn $
    Revision 1.4  2000/12/14 12:53:43  mi
    <true></true> -> <TRUE/> and same with FALSE

    Revision 1.3  2000/11/08 12:44:18  mi
    moved from api

    Revision 1.1.1.1  2000/09/18 23:35:55  hjs
    initial import

    Revision 1.6  2000/09/11 11:52:57  mi
    documentation merged from XML

    Revision 1.4  2000/08/02 10:28:59  mi
    CharacterProperties and ParagraphProperties now in sheet/SheetCell...

    Revision 1.3  2000/06/16 10:34:12  mi
    #76027# CharacterProperties only at SheetCell now

    Revision 1.2  2000/02/09 15:07:01  mi
    #72869# get/setCellStyle moved to CellProperties

    Revision 1.1.1.1  1999/11/11 09:48:45  jsc
    new


=============================================================================*/
#endif