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
  21 module com {  module sun {  module star {  module table {
  22
  23
  24 /** provides access to the cells or to sub-ranges of a cell range.
  25
  26     @see com::sun::star::table::CellRange
  27  */
  28 published interface XCellRange: com::sun::star::uno::XInterface
  29 {
  30
  31     /** Returns a single cell within the range.
  32
  33         @param nColumn
  34             is the column index of the cell inside the range.
  35
  36         @param nRow
  37             is the row index of the cell inside the range.
  38
  39         @returns
  40             the specified cell.
  41
  42         @throws com::sun::star::lang::IndexOutOfBoundsException
  43             if an index is outside the dimensions of this range.
  44
  45         @see com::sun::star::table::Cell
  46      */
  47     com::sun::star::table::XCell getCellByPosition(
  48             [in] long nColumn,
  49             [in] long nRow )
  50         raises( com::sun::star::lang::IndexOutOfBoundsException );
  51
  52
  53     /** Returns a sub-range of cells within the range.
  54
  55         @param nLeft
  56             is the column index of the first cell inside the range.
  57
  58         @param nTop
  59             is the row index of the first cell inside the range.
  60
  61         @param nRight
  62             is the column index of the last cell inside the range.
  63
  64         @param nBottom
  65             is the row index of the last cell inside the range.
  66
  67         @returns
  68             the specified cell range.
  69
  70         @throws com::sun::star::lang::IndexOutOfBoundsException
  71             if an index is outside the dimensions of this range.
  72
  73         @see com::sun::star::table::CellRange
  74      */
  75     com::sun::star::table::XCellRange getCellRangeByPosition(
  76             [in] long nLeft,
  77             [in] long nTop,
  78             [in] long nRight,
  79             [in] long nBottom )
  80         raises( com::sun::star::lang::IndexOutOfBoundsException );
  81
  82
  83     /** Returns a sub-range of cells within the range.
  84
  85         <p>The sub-range is specified by its name. The format of the range
  86         name is dependent of the context of the table. In spreadsheets valid
  87         names may be "A1:C5" or "$B$2" or even defined names for cell ranges
  88         such as "MySpecialCell".</p>
  89
  90         @param aRange
  91             the name of the sub-range.
  92
  93         @returns
  94             the specified cell range.
  95
  96         @see com::sun::star::table::CellRange
  97      */
  98     com::sun::star::table::XCellRange getCellRangeByName( [in] string aRange );
  99
 100 };
 101
 102
 103 }; }; }; };
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */