offapi/com/sun/star/sheet/XConsolidationDescriptor.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: XConsolidationDescriptor.idl,v $
  10  * $Revision: 1.9 $
  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_XConsolidationDescriptor_idl__
  32 #define __com_sun_star_sheet_XConsolidationDescriptor_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_GeneralFunction_idl__
  39 #include <com/sun/star/sheet/GeneralFunction.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  43 #include <com/sun/star/table/CellRangeAddress.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_table_CellAddress_idl__
  47 #include <com/sun/star/table/CellAddress.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** provides access to the settings of a consolidation descriptor.
  57
  58     @deprecated
  59
  60     @see com::sun::star::sheet::ConsolidationDescriptor
  61  */
  62 published interface XConsolidationDescriptor: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     /** returns the function by which the ranges are consolidated.
  67      */
  68     com::sun::star::sheet::GeneralFunction getFunction();
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** sets the function by which the ranges are consolidated.
  73      */
  74     void setFunction( [in] com::sun::star::sheet::GeneralFunction nFunction );
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** returns the cell ranges which are consolidated.
  79      */
  80     sequence< com::sun::star::table::CellRangeAddress > getSources();
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** sets the cell ranges which are consolidated.
  85      */
  86     void setSources(
  87             [in] sequence< com::sun::star::table::CellRangeAddress > aSources );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** returns the position of the top left cell of the cell range where
  92         the consolidated data are copied.
  93      */
  94     com::sun::star::table::CellAddress getStartOutputPosition();
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** sets the position of the top left cell of the cell range
  99         where the consolidated data are copied.
 100      */
 101     void setStartOutputPosition(
 102             [in] com::sun::star::table::CellAddress aStartOutputPosition );
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** returns, whether column headers from the cell ranges are used to
 107         find matching data or not.
 108      */
 109     boolean getUseColumnHeaders();
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** specifies if column headers from the cell ranges are used to find
 114         matching data.
 115      */
 116     void setUseColumnHeaders( [in] boolean bUseColumnHeaders );
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** returns, whether row headers from the cell ranges are used to
 121         find matching data or not.
 122      */
 123     boolean getUseRowHeaders();
 124
 125     //-------------------------------------------------------------------------
 126
 127     /** specifies if row headers from the cell ranges are used to find
 128         matching data.
 129      */
 130     void setUseRowHeaders( [in] boolean bUseRowHeaders );
 131
 132     //-------------------------------------------------------------------------
 133
 134     /** returns, whether links to the original data are inserted in the
 135         output area or not.
 136      */
 137     boolean getInsertLinks();
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** specifies if links to the original data are inserted in the
 142         output area.
 143      */
 144     void setInsertLinks( [in] boolean bInsertLinks );
 145
 146 };
 147
 148 //=============================================================================
 149
 150 }; }; }; };
 151
 152 #endif
 153