xref: /trunk/main/offapi/com/sun/star/table/XTable.idl (revision d1766043)
1*d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4*d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5*d1766043SAndrew Rist * distributed with this work for additional information
6*d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9*d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10*d1766043SAndrew Rist *
11*d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12*d1766043SAndrew Rist *
13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14*d1766043SAndrew Rist * software distributed under the License is distributed on an
15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17*d1766043SAndrew Rist * specific language governing permissions and limitations
18*d1766043SAndrew Rist * under the License.
19*d1766043SAndrew Rist *
20*d1766043SAndrew Rist *************************************************************/
21*d1766043SAndrew Rist
22*d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_table_XTable_idl__
25cdf0e10cSrcweir#define __com_sun_star_table_XTable_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_lang_XComponent_idl__
28cdf0e10cSrcweir#include <com/sun/star/lang/XComponent.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_table_XCellRange_idl__
32cdf0e10cSrcweir#include <com/sun/star/table/XCellRange.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
35cdf0e10cSrcweir#ifndef __com_sun_star_table_XColumnRowRange_idl__
36cdf0e10cSrcweir#include <com/sun/star/table/XColumnRowRange.idl>
37cdf0e10cSrcweir#endif
38cdf0e10cSrcweir
39cdf0e10cSrcweir#ifndef __com_sun_star_table_XCellCursor_idl__
40cdf0e10cSrcweir#include <com/sun/star/table/XCellCursor.idl>
41cdf0e10cSrcweir#endif
42cdf0e10cSrcweir
43cdf0e10cSrcweir#ifndef __com_sun_star_util_XModifiable_idl__
44cdf0e10cSrcweir#include <com/sun/star/util/XModifiable.idl>
45cdf0e10cSrcweir#endif
46cdf0e10cSrcweir
47cdf0e10cSrcweir#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
48cdf0e10cSrcweir#include <com/sun/star/beans/XMultiPropertySet.idl>
49cdf0e10cSrcweir#endif
50cdf0e10cSrcweir
51cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__
52cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl>
53cdf0e10cSrcweir#endif
54cdf0e10cSrcweir
55cdf0e10cSrcweir#ifndef __com_sun_star_beans_XFastPropertySet_idl__
56cdf0e10cSrcweir#include <com/sun/star/beans/XFastPropertySet.idl>
57cdf0e10cSrcweir#endif
58cdf0e10cSrcweir
59cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
60cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
61cdf0e10cSrcweir#endif
62cdf0e10cSrcweir
63cdf0e10cSrcweir//=============================================================================
64cdf0e10cSrcweir
65cdf0e10cSrcweirmodule com {  module sun {  module star {  module table {
66cdf0e10cSrcweir
67cdf0e10cSrcweir//=============================================================================
68cdf0e10cSrcweir
69cdf0e10cSrcweir/**
70cdf0e10cSrcweir*/
71cdf0e10cSrcweirinterface XTable
72cdf0e10cSrcweir{
73cdf0e10cSrcweir
74cdf0e10cSrcweir	interface com::sun::star::lang::XComponent;
75cdf0e10cSrcweir
76cdf0e10cSrcweir	//-------------------------------------------------------------------------
77cdf0e10cSrcweir
78cdf0e10cSrcweir	interface com::sun::star::table::XCellRange;
79cdf0e10cSrcweir
80cdf0e10cSrcweir	//-------------------------------------------------------------------------
81cdf0e10cSrcweir
82cdf0e10cSrcweir	interface com::sun::star::table::XColumnRowRange;
83cdf0e10cSrcweir
84cdf0e10cSrcweir	//-------------------------------------------------------------------------
85cdf0e10cSrcweir
86cdf0e10cSrcweir	/** interface to make the modify state of the table accessible.
87cdf0e10cSrcweir		<p>Additionally, it makes it possible to register listener objects, which
88cdf0e10cSrcweir		get notification whenever the content of the table changes.
89cdf0e10cSrcweir	*/
90cdf0e10cSrcweir	interface ::com::sun::star::util::XModifiable;
91cdf0e10cSrcweir
92cdf0e10cSrcweir	//-------------------------------------------------------------------------
93cdf0e10cSrcweir
94cdf0e10cSrcweir	/* interface ::com::sun::star::beans::XMultiPropertySet; */
95cdf0e10cSrcweir
96cdf0e10cSrcweir	//-------------------------------------------------------------------------
97cdf0e10cSrcweir
98cdf0e10cSrcweir	interface ::com::sun::star::beans::XPropertySet;
99cdf0e10cSrcweir
100cdf0e10cSrcweir	//-------------------------------------------------------------------------
101cdf0e10cSrcweir
102cdf0e10cSrcweir	interface ::com::sun::star::beans::XFastPropertySet;
103cdf0e10cSrcweir
104cdf0e10cSrcweir	//-------------------------------------------------------------------------
105cdf0e10cSrcweir
106cdf0e10cSrcweir	/** creates a cell cursor including the whole table
107cdf0e10cSrcweir
108cdf0e10cSrcweir		@see com::sun::star::table::CellCursor
109cdf0e10cSrcweir	 */
110cdf0e10cSrcweir	com::sun::star::table::XCellCursor createCursor();
111cdf0e10cSrcweir
112cdf0e10cSrcweir	//-------------------------------------------------------------------------
113cdf0e10cSrcweir
114cdf0e10cSrcweir	/** creates a cell cursor to travel in the given range context.
115cdf0e10cSrcweir
116cdf0e10cSrcweir		@param aRange
117cdf0e10cSrcweir			the cell range for the cursor.
118cdf0e10cSrcweir
119cdf0e10cSrcweir		@throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
120cdf0e10cSrcweir			if the given reference is empty or not a range from this table.
121cdf0e10cSrcweir
122cdf0e10cSrcweir		@see com::sun::star::table::CellCursor
123cdf0e10cSrcweir	 */
124cdf0e10cSrcweir	com::sun::star::table::XCellCursor createCursorByRange( [in] com::sun::star::table::XCellRange Range )
125cdf0e10cSrcweir		raises ( com::sun::star::lang::IllegalArgumentException );
126cdf0e10cSrcweir
127cdf0e10cSrcweir	//-------------------------------------------------------------------------
128cdf0e10cSrcweir
129cdf0e10cSrcweir	/** stores the current row count of this table */
130cdf0e10cSrcweir	[readonly, attribute] long RowCount;
131cdf0e10cSrcweir
132cdf0e10cSrcweir	//-------------------------------------------------------------------------
133cdf0e10cSrcweir
134cdf0e10cSrcweir	/** stores the current column count of this table */
135cdf0e10cSrcweir	[readonly, attribute] long ColumnCount;
136cdf0e10cSrcweir};
137cdf0e10cSrcweir
138cdf0e10cSrcweir//=============================================================================
139cdf0e10cSrcweir
140cdf0e10cSrcweir}; }; }; };
141cdf0e10cSrcweir
142cdf0e10cSrcweir#endif
143cdf0e10cSrcweir
144