offapi/com/sun/star/sheet/XSheetCellRanges.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 sheet {
  22
  23
  24 /** provides methods to access cell ranges in a collection via index and
  25     other helper methods.
  26
  27     @see com::sun::star::sheet::SheetCellRanges
  28  */
  29 published interface XSheetCellRanges: com::sun::star::container::XIndexAccess
  30 {
  31
  32     /** returns the collection of all used cells.
  33
  34         @see com::sun::star::sheet::Cells
  35      */
  36     com::sun::star::container::XEnumerationAccess getCells();
  37
  38
  39     /** creates a string with addresses of all contained cell ranges.
  40
  41         <p>The range addresses are separated with semicolons. For instance
  42         the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p>
  43
  44         @returns
  45             a string containing the addresses of all cell ranges.
  46      */
  47     string getRangeAddressesAsString();
  48
  49
  50     /** creates a sequence with addresses of all contained cell ranges.
  51
  52         @returns
  53             a sequence with the addresses of all cell ranges.
  54      */
  55     sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses();
  56
  57 };
  58
  59
  60 }; }; }; };
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */