offapi/com/sun/star/sheet/NamedRange.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: NamedRange.idl,v $
  10  * $Revision: 1.10.36.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_NamedRange_idl__
  32 #define __com_sun_star_sheet_NamedRange_idl__
  33
  34 #ifndef __com_sun_star_sheet_XNamedRange_idl__
  35 #include <com/sun/star/sheet/XNamedRange.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_container_XNamed_idl__
  39 #include <com/sun/star/container/XNamed.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__
  43 #include <com/sun/star/sheet/XCellRangeReferrer.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module sheet {
  49
  50 //=============================================================================
  51
  52 /** represents a named range in a spreadsheet document.
  53
  54     <p>In fact a named range is a named formula expression. A cell range
  55     address is one possible content of a named range.</p>
  56
  57     @see com::sun::star::sheet::NamedRanges
  58  */
  59 published service NamedRange
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /** provides access to the settings of the named range.
  64      */
  65     interface com::sun::star::sheet::XNamedRange;
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** provides access to the cell range object referred by this named range.
  70
  71         <p>This works only, if the named range contains a single cell range
  72         address.</p>
  73      */
  74     interface com::sun::star::sheet::XCellRangeReferrer;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** returns the index used to refer to this name in token arrays.
  79
  80         <p>A token describing a defined name shall contain the op-code obtained
  81         from the <const>FormulaMapGroupSpecialOffset::NAME</const> offset and
  82         this index as data part.</p>
  83
  84         @see com::sun::star::sheet::FormulaToken
  85         @see com::sun::star::sheet::FormulaMapGroupSpecialOffset::NAME
  86
  87         @since OOo 3.0
  88      */
  89     [optional, readonly, property] long TokenIndex;
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** Determines if this defined name represents a shared formula.
  94
  95         <p>This special property shall not be used externally. It is used by
  96         import and export filters for compatibility with spreadsheet
  97         documents containing shared formulas. Shared formulas are shared
  98         by several cells to save memory and to decrease file size.</p>
  99
 100         <p>A defined name with this property set will not appear in the user
 101         interface of Calc, and its name will not appear in cell formulas. A
 102         formula referring to this defined name will show the formula
 103         definition contained in the name instead.</p>
 104
 105         @since OOo 3.0
 106      */
 107     [optional, property] boolean IsSharedFormula;
 108 };
 109
 110 //=============================================================================
 111
 112 }; }; }; };
 113
 114 #endif
 115