diff options
Diffstat (limited to 'offapi/com/sun/star/table/XCellRange.idl')
| -rw-r--r-- | offapi/com/sun/star/table/XCellRange.idl | 212 |
1 files changed, 106 insertions, 106 deletions
diff --git a/offapi/com/sun/star/table/XCellRange.idl b/offapi/com/sun/star/table/XCellRange.idl index 37bc8d7f2..0850202cb 100644 --- a/offapi/com/sun/star/table/XCellRange.idl +++ b/offapi/com/sun/star/table/XCellRange.idl @@ -2,9 +2,9 @@ * * $RCSfile: XCellRange.idl,v $ * - * $Revision: 1.6 $ + * $Revision: 1.7 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:44 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:43 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,112 +58,112 @@ * * ************************************************************************/ -#ifndef __com_sun_star_table_XCellRange_idl__ -#define __com_sun_star_table_XCellRange_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_table_XCell_idl__ -#include <com/sun/star/table/XCell.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module table { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::table::XCellRange -/** represents a range of cells in a table.@see com::sun::star::table::CellRange + +#ifndef __com_sun_star_table_XCellRange_idl__ +#define __com_sun_star_table_XCellRange_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_table_XCell_idl__ +#include <com/sun/star/table/XCell.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module table { + +//============================================================================= + +/** provides access to the cells or to sub-ranges of a cell range. + + @see com::sun::star::table::CellRange */ interface XCellRange: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::table::XCellRange::getCellByPosition - /** @returns - the specified cell. - - @param nColumn - is the column index of the cell. - - @param nRow - is the row index of the cell. +{ + //------------------------------------------------------------------------- + + /** Returns a single cell within the range. + + @param nColumn + is the column index of the cell inside the range. + + @param nRow + is the row index of the cell inside the range. + + @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 ) - raises( com::sun::star::lang::IndexOutOfBoundsException ); - - //------------------------------------------------------------------------- - - // DocMerge from idl: method com::sun::star::table::XCellRange::getCellRangeByPosition - /** @returns - the specified sub-range. - - @param nLeft - is the column index of the first cell. - - @param nTop - is the row index of the first cell. - - @param nRight - is the column index of the last cell. - - @param nBottom - is the row index of the last cell. + com::sun::star::table::XCell getCellByPosition( + [in] long nColumn, + [in] long nRow ) + 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. + + @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 ) - raises( com::sun::star::lang::IndexOutOfBoundsException ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::table::XCellRange::getCellRangeByName - /** finds a cell or cell range by its name. + com::sun::star::table::XCellRange getCellRangeByPosition( + [in] long nLeft, + [in] long nTop, + [in] long nRight, + [in] long nBottom ) + 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 "A1:C5" or "$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 range. + + @see com::sun::star::table::CellRange */ - com::sun::star::table::XCellRange getCellRangeByName( [in] string aRange ); -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.5 2001/03/12 12:56:24 mi - package is a registered name in Java => renamed to packages (step1: new module packages) - - Revision 1.4 2000/12/21 08:35:19 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:19 mi - moved from api - - Revision 1.2 2000/10/09 14:25:01 mi - #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags) - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.4 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.2 2000/06/16 10:35:08 mi - throws exceptions now - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ -#endif + com::sun::star::table::XCellRange getCellRangeByName( [in] string aRange ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + |