xref: /aoo41x/main/offapi/com/sun/star/sheet/SheetCell.idl (revision fbef625e)
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
24#ifndef __com_sun_star_sheet_SheetCell_idl__
25#define __com_sun_star_sheet_SheetCell_idl__
26
27
28#ifndef __com_sun_star_table_Cell_idl__
29#include <com/sun/star/table/Cell.idl>
30#endif
31
32#ifndef __com_sun_star_text_Text_idl__
33#include <com/sun/star/text/Text.idl>
34#endif
35
36#ifndef __com_sun_star_style_CharacterProperties_idl__
37#include <com/sun/star/style/CharacterProperties.idl>
38#endif
39
40#ifndef __com_sun_star_style_CharacterPropertiesAsian_idl__
41#include <com/sun/star/style/CharacterPropertiesAsian.idl>
42#endif
43
44#ifndef __com_sun_star_style_CharacterPropertiesComplex_idl__
45#include <com/sun/star/style/CharacterPropertiesComplex.idl>
46#endif
47
48#ifndef __com_sun_star_style_ParagraphProperties_idl__
49#include <com/sun/star/style/ParagraphProperties.idl>
50#endif
51
52#ifndef __com_sun_star_style_ParagraphPropertiesAsian_idl__
53#include <com/sun/star/style/ParagraphPropertiesAsian.idl>
54#endif
55
56#ifndef __com_sun_star_style_ParagraphPropertiesComplex_idl__
57#include <com/sun/star/style/ParagraphPropertiesComplex.idl>
58#endif
59
60#ifndef __com_sun_star_sheet_SheetRangesQuery_idl__
61#include <com/sun/star/sheet/SheetRangesQuery.idl>
62#endif
63
64
65#ifndef __com_sun_star_document_XActionLockable_idl__
66#include <com/sun/star/document/XActionLockable.idl>
67#endif
68
69#ifndef __com_sun_star_util_XReplaceable_idl__
70#include <com/sun/star/util/XReplaceable.idl>
71#endif
72
73#ifndef __com_sun_star_util_XIndent_idl__
74#include <com/sun/star/util/XIndent.idl>
75#endif
76
77#ifndef __com_sun_star_table_XColumnRowRange_idl__
78#include <com/sun/star/table/XColumnRowRange.idl>
79#endif
80
81#ifndef __com_sun_star_sheet_XCellAddressable_idl__
82#include <com/sun/star/sheet/XCellAddressable.idl>
83#endif
84
85#ifndef __com_sun_star_sheet_XSheetAnnotationAnchor_idl__
86#include <com/sun/star/sheet/XSheetAnnotationAnchor.idl>
87#endif
88
89#ifndef __com_sun_star_text_XTextFieldsSupplier_idl__
90#include <com/sun/star/text/XTextFieldsSupplier.idl>
91#endif
92
93
94#ifndef __com_sun_star_awt_Point_idl__
95#include <com/sun/star/awt/Point.idl>
96#endif
97
98#ifndef __com_sun_star_awt_Size_idl__
99#include <com/sun/star/awt/Size.idl>
100#endif
101
102#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
103#include <com/sun/star/sheet/XSheetConditionalEntries.idl>
104#endif
105
106#ifndef __com_sun_star_beans_XPropertySet_idl__
107#include <com/sun/star/beans/XPropertySet.idl>
108#endif
109
110#ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
111#include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
112#endif
113
114#ifndef __com_sun_star_util_XModifyBroadcaster_idl__
115#include <com/sun/star/util/XModifyBroadcaster.idl>
116#endif
117
118//=============================================================================
119
120module com {  module sun {  module star {  module sheet {
121
122//=============================================================================
123
124/** represents a single addressable cell in a spreadsheet document.
125 */
126published service SheetCell
127{
128	//-------------------------------------------------------------------------
129
130	/** provides basic cell handling and contributes common cell
131		formatting properties.
132	 */
133	service com::sun::star::table::Cell;
134
135	//-------------------------------------------------------------------------
136
137	/** provides handling of formatted text cells.
138	 */
139	service com::sun::star::text::Text;
140
141	//-------------------------------------------------------------------------
142
143	/** contributes properties for character formatting of Western text.
144	 */
145	service com::sun::star::style::CharacterProperties;
146
147	//-------------------------------------------------------------------------
148
149	/** contributes properties for character formatting of Asian text.
150	 */
151	service com::sun::star::style::CharacterPropertiesAsian;
152
153	//-------------------------------------------------------------------------
154
155	/** contributes properties for character formatting of Complex text.
156	 */
157	service com::sun::star::style::CharacterPropertiesComplex;
158
159	//-------------------------------------------------------------------------
160
161	/** contributes properties for paragraph formatting.
162	 */
163	service com::sun::star::style::ParagraphProperties;
164
165	//-------------------------------------------------------------------------
166
167    /** contributes properties for paragraph formatting of Asian text.
168     */
169    [optional] service com::sun::star::style::ParagraphPropertiesAsian;
170
171    //-------------------------------------------------------------------------
172
173    /** contributes properties for paragraph formatting of Complex text.
174     */
175    [optional] service com::sun::star::style::ParagraphPropertiesComplex;
176
177    //-------------------------------------------------------------------------
178
179	/** provides interfaces to find cells with specific properties.
180	 */
181	service com::sun::star::sheet::SheetRangesQuery;
182
183	//=========================================================================
184
185	/** provides methods to lock and unlock the update between
186		<type scope="com::sun::star::table">XCell</type> and
187		<type scope="com::sun::star::text">XText</type>.
188	*/
189	interface com::sun::star::document::XActionLockable;
190
191	//-------------------------------------------------------------------------
192
193	/** provides "Find & Replace" functionality.
194
195		<p>The property
196		<member scope="com::sun::star::util">SearchDescriptor::SearchWords</member>
197		has a different meaning in spreadsheets: If set to <TRUE/>, the
198		spreadsheet searches for cells containing the serch text only.</p>
199	 */
200	interface com::sun::star::util::XReplaceable;
201
202	//-------------------------------------------------------------------------
203
204	/** provides modifying the cell indentation.
205	 */
206	interface com::sun::star::util::XIndent;
207
208	//-------------------------------------------------------------------------
209
210	/** provides access to the collections of columns and rows.
211	 */
212	interface com::sun::star::table::XColumnRowRange;
213
214	//-------------------------------------------------------------------------
215
216	/** provides access to the cell address of this cell.
217	 */
218	interface com::sun::star::sheet::XCellAddressable;
219
220	//-------------------------------------------------------------------------
221
222	/** provides access to the annotation attached to this cell.
223	 */
224	interface com::sun::star::sheet::XSheetAnnotationAnchor;
225
226	//-------------------------------------------------------------------------
227
228	/** provides access to the text fields used in this cell.
229	 */
230	interface com::sun::star::text::XTextFieldsSupplier;
231
232	//-------------------------------------------------------------------------
233
234    [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
235
236	//-------------------------------------------------------------------------
237
238	/**
239
240	@since OpenOffice 2.0
241
242	*/
243	[optional] interface com::sun::star::util::XModifyBroadcaster;
244
245	//=========================================================================
246
247	/** contains the position of this cell in the sheet (in 1/100 mm).
248
249		<p>This property contains the absolute position in the whole
250		sheet, not the position in the visible area.</p>
251	 */
252	[readonly, property] com::sun::star::awt::Point Position;
253
254	//-------------------------------------------------------------------------
255
256	/** contains the size of this cell (in 1/100 mm).
257	 */
258	[readonly, property] com::sun::star::awt::Size Size;
259
260	//-------------------------------------------------------------------------
261
262	/** contains the formula string with localized function names.
263
264		<p>This property can also be used to set a new localized formula.</p>
265	 */
266	[optional, property] string FormulaLocal;
267
268	//-------------------------------------------------------------------------
269
270	/** contains the result type of a formula.
271
272		@see com::sun::star::sheet::FormulaResult
273	 */
274	[readonly, property] long FormulaResultType;
275
276	//-------------------------------------------------------------------------
277
278	/** contains the conditional formatting settings for this cell.
279
280		<p>After a conditional format has been changed it has to be
281		reinserted into the property set.</p>
282
283		@see com::sun::star::sheet::TableConditionalFormat
284	 */
285	[property] com::sun::star::sheet::XSheetConditionalEntries
286		ConditionalFormat;
287
288	//-------------------------------------------------------------------------
289
290	/** contains the conditional formatting settings for this cell,
291		using localized formulas.
292
293		<p>After a conditional format has been changed it has to be
294		reinserted into the property set.</p>
295
296		@see com::sun::star::sheet::TableConditionalFormat
297	 */
298	[optional, property] com::sun::star::sheet::XSheetConditionalEntries
299		ConditionalFormatLocal;
300
301	//-------------------------------------------------------------------------
302
303	/** contains the data validation settings for this cell.
304
305		<p>After the data validation settings have been changed the
306		validation has to be reinserted into the property set.</p>
307
308		@see com::sun::star::sheet::TableValidation
309	 */
310	[property] com::sun::star::beans::XPropertySet Validation;
311
312	//-------------------------------------------------------------------------
313
314	/** contains the data validation settings for this cell,
315		using localized formulas.
316
317		<p>After the data validation settings have been changed the
318		validation has to be reinserted into the property set.</p>
319
320		@see com::sun::star::sheet::TableValidation
321	 */
322	[optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
323
324	//-------------------------------------------------------------------------
325
326	/** Returns the absolute adress of the range as string, e.g. "$Sheet1.$B$2".
327	 */
328	[optional, readonly, property] string AbsoluteName;
329};
330
331//=============================================================================
332
333}; }; }; };
334
335#endif
336
337