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