INTEGRATION: CWS chart2mst3 (1.1.2); FILE ADDED

2005/10/11 12:15:51 bm 1.1.2.2: license header change
2005/05/12 19:48:26 sab 1.1.2.1: get access to ranges

1 files changed, 160 insertions, 0 deletions

diff --git a/offapi/com/sun/star/sheet/XCellRangesAccess.idl b/offapi/com/sun/star/sheet/XCellRangesAccess.idl
new file mode 100644
index 000000000000..f602fd3fcf1f
--- /dev/null
+++ b/offapi/com/sun/star/sheet/XCellRangesAccess.idl
@@ -0,0 +1,160 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: XCellRangesAccess.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2007-05-22 15:11:10 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_sheet_XCellRangesAccess_idl__
+#define __com_sun_star_sheet_XCellRangesAccess_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
+#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
+#endif
+
+#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#endif
+
+#ifndef __com_sun_star_table_XCell_idl__
+#include <com/sun/star/table/XCell.idl>
+#endif
+
+#ifndef __com_sun_star_table_XCellRange_idl__
+#include <com/sun/star/table/XCellRange.idl>
+#endif
+
+//=============================================================================
+
+module com {  module sun {  module star {  module sheet {
+
+//=============================================================================
+
+/** provides access to the cells or to sub-ranges of all sheets.
+
+    @see com::sun::star::sheet::Spreadsheets
+ */
+published interface XCellRangesAccess: com::sun::star::uno::XInterface
+{
+    //-------------------------------------------------------------------------
+
+    /** Returns a single cell within the range.
+
+        @param nColumn
+            is the column index of the cell inside the sheet.
+
+        @param nRow
+            is the row index of the cell inside the sheet.
+
+        @param nSheet
+            is the sheet index of the sheet inside the document.
+
+        @returns
+            the specified cell.
+
+        @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
+            if an index is outside the dimensions of this range.
+
+        @see com::sun::star::table::Cell
+     */
+    com::sun::star::table::XCell getCellByPosition(
+            [in] long nColumn,
+            [in] long nRow,
+            [in] long nSheet )
+        raises( com::sun::star::lang::IndexOutOfBoundsException );
+
+    //-------------------------------------------------------------------------
+
+    /** Returns a sub-range of cells within the range.
+
+        @param nLeft
+            is the column index of the first cell inside the range.
+
+        @param nTop
+            is the row index of the first cell inside the range.
+
+        @param nRight
+            is the column index of the last cell inside the range.
+
+        @param nBottom
+            is the row index of the last cell inside the range.
+
+        @param nSheet
+            is the sheet index of the sheet inside the document.
+
+        @returns
+            the specified cell range.
+
+        @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
+            if an index is outside the dimensions of this range.
+
+        @see com::sun::star::table::CellRange
+     */
+    com::sun::star::table::XCellRange getCellRangeByPosition(
+            [in] long nLeft,
+            [in] long nTop,
+            [in] long nRight,
+            [in] long nBottom,
+            [in] long nSheet )
+        raises( com::sun::star::lang::IndexOutOfBoundsException );
+
+    //-------------------------------------------------------------------------
+
+    /** Returns a sub-range of cells within the range.
+
+        <p>The sub-range is specified by its name. The format of the range
+        name is dependent of the context of the table. In spreadsheets valid
+        names may be "Sheet1.A1:C5" or "$Sheet1.$B$2" or even defined names for cell ranges
+        such as "MySpecialCell".</p>
+
+        @param aRange
+            the name of the sub-range.
+
+        @returns
+            the specified cell ranges.
+
+        @see com::sun::star::table::CellRange
+     */
+    sequence <com::sun::star::table::XCellRange> getCellRangesByName( [in] string aRange )
+        raises( com::sun::star::lang::IllegalArgumentException );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+