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