offapi/com/sun/star/sheet/XNamedRanges.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 /** provides access to the members in a collection of named ranges and to
  25     insert and remove them.
  26
  27     @see com::sun::star::sheet::NamedRanges
  28     @see com::sun::star::sheet::NamedRange
  29  */
  30 published interface XNamedRanges: com::sun::star::container::XNameAccess
  31 {
  32
  33     /** adds a new named range to the collection.
  34
  35         @param aName
  36             the new name of the named range.
  37
  38         @param aContent
  39             the formula expression.
  40
  41             <p>A cell range address is one possible content of a named
  42             range.</p>
  43
  44         @param aPosition
  45             specifies the base address for relative cell references.
  46
  47         @param nType
  48             a combination of flags that specify the type of a named range,
  49             as defined in NamedRangeFlag.
  50
  51             <p>This parameter will be zero for any common named range.</p>
  52      */
  53     void addNewByName(
  54             [in] string aName,
  55             [in] string aContent,
  56             [in] com::sun::star::table::CellAddress aPosition,
  57             [in] long nType );
  58
  59
  60     /** creates named cell ranges from titles in a cell range.
  61
  62         <p>The names for the named ranges are taken from title cells in the
  63         top or bottom row, or from the cells of the left or right column
  64         of the range (depending on the parameter aBorder.
  65         The named ranges refer to single columns or rows in the inner
  66         part of the original range, excluding the labels.</p>
  67
  68         <p>Example: The source range is A1:B3. The named ranges shall be
  69         created using row titles. This requires Border::TOP
  70         for the second parameter. The method creates two named ranges. The
  71         name of the first is equal to the content of cell A1 and contains the
  72         range $Sheet.$A$2:$A$3 (excluding the title cell). The latter named
  73         range is named using cell B1 and contains the cell range address
  74         $Sheet.$B$2:$B$3.</p>
  75
  76         @param aSource
  77             the cell range used to create the named ranges.
  78
  79         @param aBorder
  80             specifies the location of the title cells.
  81      */
  82     void addNewFromTitles(
  83             [in] com::sun::star::table::CellRangeAddress aSource,
  84             [in] com::sun::star::sheet::Border aBorder );
  85
  86
  87     /** removes a named range from the collection.
  88      */
  89     void removeByName( [in] string aName );
  90
  91
  92     /** writes a list of all named ranges into the document.
  93
  94         <p>The first column of the list contains the names. The second
  95         column contains the contents of the named ranges.</p>
  96
  97         @param aOutputPosition
  98             specifies the top left cell of the output range.
  99      */
 100     void outputList( [in] com::sun::star::table::CellAddress aOutputPosition );
 101
 102 };
 103
 104
 105 }; }; }; };
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */