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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_table_XCellRange_idl__
  21 #define __com_sun_star_table_XCellRange_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  25 #include <com/sun/star/table/XCell.idl>
  26
  27
  28 module com {  module sun {  module star {  module table {
  29
  30
  31 /** provides access to the cells or to sub-ranges of a cell range.
  32
  33     @see com::sun::star::table::CellRange
  34  */
  35 published interface XCellRange: com::sun::star::uno::XInterface
  36 {
  37
  38     /** Returns a single cell within the range.
  39
  40         @param nColumn
  41             is the column index of the cell inside the range.
  42
  43         @param nRow
  44             is the row index of the cell inside the range.
  45
  46         @returns
  47             the specified cell.
  48
  49         @throws com::sun::star::lang::IndexOutOfBoundsException
  50             if an index is outside the dimensions of this range.
  51
  52         @see com::sun::star::table::Cell
  53      */
  54     com::sun::star::table::XCell getCellByPosition(
  55             [in] long nColumn,
  56             [in] long nRow )
  57         raises( com::sun::star::lang::IndexOutOfBoundsException );
  58
  59
  60     /** Returns a sub-range of cells within the range.
  61
  62         @param nLeft
  63             is the column index of the first cell inside the range.
  64
  65         @param nTop
  66             is the row index of the first cell inside the range.
  67
  68         @param nRight
  69             is the column index of the last cell inside the range.
  70
  71         @param nBottom
  72             is the row index of the last cell inside the range.
  73
  74         @returns
  75             the specified cell range.
  76
  77         @throws com::sun::star::lang::IndexOutOfBoundsException
  78             if an index is outside the dimensions of this range.
  79
  80         @see com::sun::star::table::CellRange
  81      */
  82     com::sun::star::table::XCellRange getCellRangeByPosition(
  83             [in] long nLeft,
  84             [in] long nTop,
  85             [in] long nRight,
  86             [in] long nBottom )
  87         raises( com::sun::star::lang::IndexOutOfBoundsException );
  88
  89
  90     /** Returns a sub-range of cells within the range.
  91
  92         <p>The sub-range is specified by its name. The format of the range
  93         name is dependent of the context of the table. In spreadsheets valid
  94         names may be "A1:C5" or "$B$2" or even defined names for cell ranges
  95         such as "MySpecialCell".</p>
  96
  97         @param aRange
  98             the name of the sub-range.
  99
 100         @returns
 101             the specified cell range.
 102
 103         @see com::sun::star::table::CellRange
 104      */
 105     com::sun::star::table::XCellRange getCellRangeByName( [in] string aRange );
 106
 107 };
 108
 109
 110 }; }; }; };
 111
 112 #endif
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */