xref: /aoo4110/main/offapi/com/sun/star/table/XTable.idl (revision b1cdbd2c)
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_table_XTable_idl__
25#define __com_sun_star_table_XTable_idl__
26
27#ifndef __com_sun_star_lang_XComponent_idl__
28#include <com/sun/star/lang/XComponent.idl>
29#endif
30
31#ifndef __com_sun_star_table_XCellRange_idl__
32#include <com/sun/star/table/XCellRange.idl>
33#endif
34
35#ifndef __com_sun_star_table_XColumnRowRange_idl__
36#include <com/sun/star/table/XColumnRowRange.idl>
37#endif
38
39#ifndef __com_sun_star_table_XCellCursor_idl__
40#include <com/sun/star/table/XCellCursor.idl>
41#endif
42
43#ifndef __com_sun_star_util_XModifiable_idl__
44#include <com/sun/star/util/XModifiable.idl>
45#endif
46
47#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
48#include <com/sun/star/beans/XMultiPropertySet.idl>
49#endif
50
51#ifndef __com_sun_star_beans_XPropertySet_idl__
52#include <com/sun/star/beans/XPropertySet.idl>
53#endif
54
55#ifndef __com_sun_star_beans_XFastPropertySet_idl__
56#include <com/sun/star/beans/XFastPropertySet.idl>
57#endif
58
59#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
60#include <com/sun/star/lang/IllegalArgumentException.idl>
61#endif
62
63//=============================================================================
64
65module com {  module sun {  module star {  module table {
66
67//=============================================================================
68
69/**
70*/
71interface XTable
72{
73
74	interface com::sun::star::lang::XComponent;
75
76	//-------------------------------------------------------------------------
77
78	interface com::sun::star::table::XCellRange;
79
80	//-------------------------------------------------------------------------
81
82	interface com::sun::star::table::XColumnRowRange;
83
84	//-------------------------------------------------------------------------
85
86	/** interface to make the modify state of the table accessible.
87		<p>Additionally, it makes it possible to register listener objects, which
88		get notification whenever the content of the table changes.
89	*/
90	interface ::com::sun::star::util::XModifiable;
91
92	//-------------------------------------------------------------------------
93
94	/* interface ::com::sun::star::beans::XMultiPropertySet; */
95
96	//-------------------------------------------------------------------------
97
98	interface ::com::sun::star::beans::XPropertySet;
99
100	//-------------------------------------------------------------------------
101
102	interface ::com::sun::star::beans::XFastPropertySet;
103
104	//-------------------------------------------------------------------------
105
106	/** creates a cell cursor including the whole table
107
108		@see com::sun::star::table::CellCursor
109	 */
110	com::sun::star::table::XCellCursor createCursor();
111
112	//-------------------------------------------------------------------------
113
114	/** creates a cell cursor to travel in the given range context.
115
116		@param aRange
117			the cell range for the cursor.
118
119		@throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
120			if the given reference is empty or not a range from this table.
121
122		@see com::sun::star::table::CellCursor
123	 */
124	com::sun::star::table::XCellCursor createCursorByRange( [in] com::sun::star::table::XCellRange Range )
125		raises ( com::sun::star::lang::IllegalArgumentException );
126
127	//-------------------------------------------------------------------------
128
129	/** stores the current row count of this table */
130	[readonly, attribute] long RowCount;
131
132	//-------------------------------------------------------------------------
133
134	/** stores the current column count of this table */
135	[readonly, attribute] long ColumnCount;
136};
137
138//=============================================================================
139
140}; }; }; };
141
142#endif
143
144