offapi/com/sun/star/sheet/XLabelRanges.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_XLabelRanges_idl__
  21 #define __com_sun_star_sheet_XLabelRanges_idl__
  22
  23 #include <com/sun/star/container/XIndexAccess.idl>
  24 #include <com/sun/star/table/CellRangeAddress.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides methods to access the members of a label range collection
  31     and to insert and remove them.
  32
  33     @see com::sun::star::sheet::LabelRanges
  34     @see com::sun::star::sheet::LabelRange
  35  */
  36 published interface XLabelRanges: com::sun::star::container::XIndexAccess
  37 {
  38
  39     /** adds a new label range to the collection.
  40
  41         @param aLabelArea
  42             the cell range containing the titles of the label range.
  43
  44         @param aDataArea
  45             the cell range containing the values of the label range.
  46      */
  47     void addNew(
  48             [in] com::sun::star::table::CellRangeAddress aLabelArea,
  49             [in] com::sun::star::table::CellRangeAddress aDataArea );
  50
  51
  52     /** removes a label range from the collection.
  53      */
  54     void removeByIndex( [in] long nIndex );
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */