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