offapi/com/sun/star/sheet/NamedRange.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_NamedRange_idl__
  21 #define __com_sun_star_sheet_NamedRange_idl__
  22
  23 #include <com/sun/star/sheet/XNamedRange.idl>
  24 #include <com/sun/star/container/XNamed.idl>
  25 #include <com/sun/star/sheet/XCellRangeReferrer.idl>
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** represents a named range in a spreadsheet document.
  32
  33     <p>In fact a named range is a named formula expression. A cell range
  34     address is one possible content of a named range.</p>
  35
  36     @see com::sun::star::sheet::NamedRanges
  37  */
  38 published service NamedRange
  39 {
  40
  41     /** provides access to the settings of the named range.
  42      */
  43     interface com::sun::star::sheet::XNamedRange;
  44
  45
  46     /** provides access to the cell range object referred by this named range.
  47
  48         <p>This works only, if the named range contains a single cell range
  49         address.</p>
  50      */
  51     interface com::sun::star::sheet::XCellRangeReferrer;
  52
  53
  54     /** returns the index used to refer to this name in token arrays.
  55
  56         <p>A token describing a defined name shall contain the op-code obtained
  57         from the FormulaMapGroupSpecialOffset::NAME offset and
  58         this index as data part.</p>
  59
  60         @see com::sun::star::sheet::FormulaToken
  61         @see com::sun::star::sheet::FormulaMapGroupSpecialOffset::NAME
  62
  63         @since OOo 3.0
  64      */
  65     [optional, readonly, property] long TokenIndex;
  66
  67
  68     /** Determines if this defined name represents a shared formula.
  69
  70         <p>This special property shall not be used externally. It is used by
  71         import and export filters for compatibility with spreadsheet
  72         documents containing shared formulas. Shared formulas are shared
  73         by several cells to save memory and to decrease file size.</p>
  74
  75         <p>A defined name with this property set will not appear in the user
  76         interface of Calc, and its name will not appear in cell formulas. A
  77         formula referring to this defined name will show the formula
  78         definition contained in the name instead.</p>
  79
  80         @since OOo 3.0
  81      */
  82     [optional, property] boolean IsSharedFormula;
  83 };
  84
  85
  86 }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */