offapi/com/sun/star/table/XCellRange.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XCellRange.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_table_XCellRange_idl__
  32 #define __com_sun_star_table_XCellRange_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
  39 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_XCell_idl__
  43 #include <com/sun/star/table/XCell.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module table {
  49
  50 //=============================================================================
  51
  52 /** provides access to the cells or to sub-ranges of a cell range.
  53
  54     @see com::sun::star::table::CellRange
  55  */
  56 published interface XCellRange: com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** Returns a single cell within the range.
  61
  62         @param nColumn
  63             is the column index of the cell inside the range.
  64
  65         @param nRow
  66             is the row index of the cell inside the range.
  67
  68         @returns
  69             the specified cell.
  70
  71         @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
  72             if an index is outside the dimensions of this range.
  73
  74         @see com::sun::star::table::Cell
  75      */
  76     com::sun::star::table::XCell getCellByPosition(
  77             [in] long nColumn,
  78             [in] long nRow )
  79         raises( com::sun::star::lang::IndexOutOfBoundsException );
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** Returns a sub-range of cells within the range.
  84
  85         @param nLeft
  86             is the column index of the first cell inside the range.
  87
  88         @param nTop
  89             is the row index of the first cell inside the range.
  90
  91         @param nRight
  92             is the column index of the last cell inside the range.
  93
  94         @param nBottom
  95             is the row index of the last cell inside the range.
  96
  97         @returns
  98             the specified cell range.
  99
 100         @throws <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
 101             if an index is outside the dimensions of this range.
 102
 103         @see com::sun::star::table::CellRange
 104      */
 105     com::sun::star::table::XCellRange getCellRangeByPosition(
 106             [in] long nLeft,
 107             [in] long nTop,
 108             [in] long nRight,
 109             [in] long nBottom )
 110         raises( com::sun::star::lang::IndexOutOfBoundsException );
 111
 112     //-------------------------------------------------------------------------
 113
 114     /** Returns a sub-range of cells within the range.
 115
 116         <p>The sub-range is specified by its name. The format of the range
 117         name is dependent of the context of the table. In spreadsheets valid
 118         names may be "A1:C5" or "$B$2" or even defined names for cell ranges
 119         such as "MySpecialCell".</p>
 120
 121         @param aRange
 122             the name of the sub-range.
 123
 124         @returns
 125             the specified cell range.
 126
 127         @see com::sun::star::table::CellRange
 128      */
 129     com::sun::star::table::XCellRange getCellRangeByName( [in] string aRange );
 130
 131 };
 132
 133 //=============================================================================
 134
 135 }; }; }; };
 136
 137 #endif
 138