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