offapi/com/sun/star/chart2/data/TabularDataProviderArguments.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef com_sun_star_chart2_data_TabularDataProviderArguments_idl
  29 #define com_sun_star_chart2_data_TabularDataProviderArguments_idl
  30
  31 #include <com/sun/star/chart/ChartDataRowSource.idl>
  32
  33 module com
  34 {
  35 module sun
  36 {
  37 module star
  38 {
  39 module chart2
  40 {
  41 module data
  42 {
  43
  44 /**
  45   */
  46 service TabularDataProviderArguments
  47 {
  48     /** the range address string spanning all data.
  49
  50         <p>The range address string must be interpretable by the
  51         component that implements <type>XDataProvider</type> and gets
  52         this property as argument to
  53         <member>XDataProvider::detectArguments</member>.</p>
  54
  55         <p>The representation string is of a form that may be used in the
  56         user interface.  Example for OOo Calc: "$Sheet1.$A$1:$D$7",
  57         example for OOo Writer: "&lt;Table1.A1:D7&gt;".</p>
  58
  59         <p>When used as input, this range will be split in columns or
  60         rows depending on the property
  61         <member>DataRowSource</member>.</p>
  62
  63         <p>When used as output of
  64         <member>XDataProvider::detectArguments</member> this is the
  65         range that spans the ranges of all given
  66         <type>XDataSequence</type>s.  If the result is ambiguous,
  67         i.e., a splitting of this range would not yield the same
  68         result, this property should be empty.  The latter is the
  69         case, when ranges are overlapping, the lengths of sequences
  70         are not equal or even if the order of two sequences is swapped
  71         (e.g. data comes from column A, C, B).</p>
  72      */
  73     [property]   string                                        CellRangeRepresentation;
  74
  75     /** determines, whether data sequences are created out of columns
  76         or rows in a table.
  77
  78         <p>If this property is not given as argument it is assumed to
  79         <member scope="com::sun::star::chart">ChartDataRowSource::COLUMNS</member>,
  80         i.e., the default is "take data from columns".</p>
  81      */
  82     [property]   ::com::sun::star::chart::ChartDataRowSource   DataRowSource;
  83
  84     /** If data comes from columns, the first row will provide the
  85         labels for all sequences, if data comes from rows, the first
  86         column will provide the labels for all sequences.
  87
  88         <p>Even if this property is false, the
  89         <type>XLabeledDataSequence</type> may contain a label, but
  90         this will not be the first cell of the selection.  It may be a
  91         generic string like "Column C".</p>
  92
  93         <p>If this property is not given as argument it is assumed to
  94         be <FALSE/>, i.e., the default is "no labels".</p>
  95      */
  96     [property]   boolean                                       FirstCellAsLabel;
  97
  98     /** determines the order of the created labeled sequences
  99
 100         <p>For example a SequenceMapping of [3,0,2,1] indicates that
 101         the sequence from old position "3" should now be the first one.
 102         Then comes the sequence from old position "0". Then that one
 103         from old position "2" and then the sequence from old position "1".</p>
 104
 105         <p>If the SequenceMapping contains invalid indexes just
 106         ignore those single indexes. For example if you only have three
 107         labeled sequences and a SequenceMapping [2,5,1,0], you should
 108         ignore the "5" and continue to place the sequence from
 109         old index "1" to the next new position and so on.</p>
 110
 111         <p>If the given SequenceMapping does not cover all existing
 112         labeled sequences just put the remaining sequences in old order
 113         behind the others. For example you have 4 sequences and a
 114         SequenceMapping [3,1]. The result should be a as if [3,1,0,2]
 115         was given.</p>
 116      */
 117     [property]   sequence< long >                              SequenceMapping;
 118
 119     /** If <FALSE/> the data provider may create a data sequence
 120         containing generated categories that fit the rest of the data,
 121         like e.g. "Row 12", "Row 13", etc.
 122
 123         <p>This property is not relevant for the splitting up of the
 124         data.  It just indicates, if the chart wants to use part of
 125         the data as categories, so that generic categories can be
 126         returned if it doesn't.</p>
 127
 128         <p>The generic category labeled sequence returned should be
 129         the first one in the returned <type>XDataSource</type>. It
 130         needs no label. The values should have their role set to
 131         "categories".  The generic strings returned should also be
 132         localized.</p>
 133      */
 134     [optional, property] boolean                               HasCategories;
 135
 136     /** This property is for providing proprietary table indexes for
 137         each table appearing in a range given in
 138         CellRangeRepresentation.
 139
 140         @deprecated
 141
 142         <p>This argument is supported by Spreadsheets in order to be
 143         able to export a document into the StarOffice 5.0 binary
 144         format.</p>
 145
 146         <p>Example: If you have the sheets (Sheet1, Sheet2, Sheet3) in
 147         your document and a chart uses the range
 148         "Sheet2.A1:.A5 Sheet3.A1:.A5 Sheet2.B1:.B5 Sheet1:B1:.B5", your
 149         TableNumberList would be "1 2 1 0".  A simple range like
 150         "Sheet1.A1:.E4" would have the TableNumberList in "0"</p>.
 151      */
 152     [optional, property] string                               TableNumberList;
 153 };
 154
 155 } ; // data
 156 } ; // chart2
 157 } ; // com
 158 } ; // sun
 159 } ; // star
 160
 161
 162 #endif
 163
 164 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */