xref: /aoo4110/main/offapi/com/sun/star/table/XTable.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_table_XTable_idl__
#define __com_sun_star_table_XTable_idl__

#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif

#ifndef __com_sun_star_table_XCellRange_idl__
#include <com/sun/star/table/XCellRange.idl>
#endif

#ifndef __com_sun_star_table_XColumnRowRange_idl__
#include <com/sun/star/table/XColumnRowRange.idl>
#endif

#ifndef __com_sun_star_table_XCellCursor_idl__
#include <com/sun/star/table/XCellCursor.idl>
#endif

#ifndef __com_sun_star_util_XModifiable_idl__
#include <com/sun/star/util/XModifiable.idl>
#endif

#ifndef __com_sun_star_beans_XMultiPropertySet_idl__
#include <com/sun/star/beans/XMultiPropertySet.idl>
#endif

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

#ifndef __com_sun_star_beans_XFastPropertySet_idl__
#include <com/sun/star/beans/XFastPropertySet.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

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

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

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

/**
*/
interface XTable
{

	interface com::sun::star::lang::XComponent;

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

	interface com::sun::star::table::XCellRange;

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

	interface com::sun::star::table::XColumnRowRange;

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

	/** interface to make the modify state of the table accessible.
		<p>Additionally, it makes it possible to register listener objects, which
		get notification whenever the content of the table changes.
	*/
	interface ::com::sun::star::util::XModifiable;

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

	/* interface ::com::sun::star::beans::XMultiPropertySet; */

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

	interface ::com::sun::star::beans::XPropertySet;

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

	interface ::com::sun::star::beans::XFastPropertySet;

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

	/** creates a cell cursor including the whole table

		@see com::sun::star::table::CellCursor
	 */
	com::sun::star::table::XCellCursor createCursor();

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

	/** creates a cell cursor to travel in the given range context.

		@param aRange
			the cell range for the cursor.

		@throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
			if the given reference is empty or not a range from this table.

		@see com::sun::star::table::CellCursor
	 */
	com::sun::star::table::XCellCursor createCursorByRange( [in] com::sun::star::table::XCellRange Range )
		raises ( com::sun::star::lang::IllegalArgumentException );

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

	/** stores the current row count of this table */
	[readonly, attribute] long RowCount;

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

	/** stores the current column count of this table */
	[readonly, attribute] long ColumnCount;
};

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

}; }; }; };

#endif