offapi/com/sun/star/sheet/XConsolidationDescriptor.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 settings of a consolidation descriptor.
  25
  26     @deprecated
  27
  28     @see com::sun::star::sheet::ConsolidationDescriptor
  29  */
  30 published interface XConsolidationDescriptor: com::sun::star::uno::XInterface
  31 {
  32
  33     /** returns the function by which the ranges are consolidated.
  34      */
  35     com::sun::star::sheet::GeneralFunction getFunction();
  36
  37
  38     /** sets the function by which the ranges are consolidated.
  39      */
  40     void setFunction( [in] com::sun::star::sheet::GeneralFunction nFunction );
  41
  42
  43     /** returns the cell ranges which are consolidated.
  44      */
  45     sequence< com::sun::star::table::CellRangeAddress > getSources();
  46
  47
  48     /** sets the cell ranges which are consolidated.
  49      */
  50     void setSources(
  51             [in] sequence< com::sun::star::table::CellRangeAddress > aSources );
  52
  53
  54     /** returns the position of the top left cell of the cell range where
  55         the consolidated data are copied.
  56      */
  57     com::sun::star::table::CellAddress getStartOutputPosition();
  58
  59
  60     /** sets the position of the top left cell of the cell range
  61         where the consolidated data are copied.
  62      */
  63     void setStartOutputPosition(
  64             [in] com::sun::star::table::CellAddress aStartOutputPosition );
  65
  66
  67     /** returns, whether column headers from the cell ranges are used to
  68         find matching data or not.
  69      */
  70     boolean getUseColumnHeaders();
  71
  72
  73     /** specifies if column headers from the cell ranges are used to find
  74         matching data.
  75      */
  76     void setUseColumnHeaders( [in] boolean bUseColumnHeaders );
  77
  78
  79     /** returns, whether row headers from the cell ranges are used to
  80         find matching data or not.
  81      */
  82     boolean getUseRowHeaders();
  83
  84
  85     /** specifies if row headers from the cell ranges are used to find
  86         matching data.
  87      */
  88     void setUseRowHeaders( [in] boolean bUseRowHeaders );
  89
  90
  91     /** returns, whether links to the original data are inserted in the
  92         output area or not.
  93      */
  94     boolean getInsertLinks();
  95
  96
  97     /** specifies if links to the original data are inserted in the
  98         output area.
  99      */
 100     void setInsertLinks( [in] boolean bInsertLinks );
 101
 102 };
 103
 104
 105 }; }; }; };
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */