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