offapi/com/sun/star/chart2/data/DataSequence.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 #ifndef com_sun_star_chart2_data_DataSequence_idl
  20 #define com_sun_star_chart2_data_DataSequence_idl
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23 #include <com/sun/star/container/XIndexReplace.idl>
  24 #include <com/sun/star/util/XCloneable.idl>
  25 #include <com/sun/star/util/XModifyBroadcaster.idl>
  26 #include <com/sun/star/chart2/data/XDataSequence.idl>
  27 #include <com/sun/star/chart2/data/XNumericalDataSequence.idl>
  28 #include <com/sun/star/chart2/data/XTextualDataSequence.idl>
  29 #include <com/sun/star/chart2/data/DataSequenceRole.idl>
  30
  31 module com
  32 {
  33 module sun
  34 {
  35 module star
  36 {
  37 module chart2
  38 {
  39 module data
  40 {
  41
  42 /** describes a container for a sequence of values.
  43
  44     <p>With the interface XDataSequence it is possible to
  45     transfer a complete sequence of values.
  46
  47     <p>With the optional
  48     com::sun::star::container::XIndexReplace it is
  49     possible to modify single elements, if the corresponding
  50     DataProvider supports modification of its values.</p>
  51   */
  52 service DataSequence
  53 {
  54     /** provides read- and write-access to the underlying data.
  55      */
  56     interface XDataSequence;
  57
  58     /** you may implement this interface to allow a fast access to
  59         numerical data.  With this interface you can get a
  60         `sequence` of `double` values.
  61     */
  62     [optional] interface   XNumericalDataSequence;
  63
  64     /** you may implement this interface to allow a fast access to
  65         textual data.  With this interface you can get a
  66         `sequence` of `string` values.
  67     */
  68     [optional] interface   XTextualDataSequence;
  69
  70     /** provides read- and write-access to single elements of the
  71         underlying data.
  72
  73         <p>Only when supporting this interface, it is possible for
  74         client applications to modify the content of the data that is
  75         provided by this DataSequence.</p>
  76      */
  77     [optional] interface ::com::sun::star::container::XIndexReplace;
  78
  79     /** Allows creating copies of data sequences.  If this interface
  80         is not supported, the same object will be shared if used by
  81         multiple objects.
  82
  83         <p>Cloning is especially useful when using identifiers.  A
  84         cloned data sequence will get a new identifier while the
  85         source range representation is identical to the original
  86         one.</p>
  87
  88         <p>Note that, when this interface is not implemented the
  89         releasing of identifiers at the XDataProvider
  90         will not work properly, because more than one object may use
  91         the same identifier.  So, when an object releases the
  92         identifier, another object might use a stale identifier.</p>
  93      */
  94     [optional] interface ::com::sun::star::util::XCloneable;
  95
  96     /** is used to broadcast change events whenever the content (data)
  97         or the range representations change.
  98      */
  99     interface com::sun::star::util::XModifyBroadcaster;
 100
 101     /** the property interface by which the properties of all
 102         supported services are exchanged
 103     */
 104     interface ::com::sun::star::beans::XPropertySet;
 105
 106
 107     /** The key (index) of the number format that this sequence should
 108         be formatted with.
 109
 110         <p>The key identifies a number format in an
 111         com::sun::star::util::XNumberFormats
 112         object.  This object can be retrieved by the
 113         com::sun::star::util::XNumberFormatsSupplier
 114         interface supported by
 115         com::sun::star::chart::ChartDocument.</p>
 116
 117         @todo use proper number format instead of a transient key.
 118      */
 119 //     [optional, property] long                     NumberFormatKey;
 120
 121     /** The role of the series inside a data series.  This may be any
 122         string.  However some strings are predefined and should always
 123         be used in the same way.
 124
 125         @see DataSequenceRole
 126      */
 127     [property] DataSequenceRole                   Role;
 128
 129     /** If set to false `FALSE`, values from hidden cells are not returned.
 130      */
 131     [optional, property] boolean                  IncludeHiddenCells;
 132
 133     /** a sequence of indexes that identify values that are hidden in the underlying
 134         data provider.
 135      */
 136     [optional, property] sequence< long >         HiddenValues;
 137 };
 138
 139 } ; // data
 140 } ; // chart2
 141 } ; // com
 142 } ; // sun
 143 } ; // star
 144
 145
 146 #endif
 147
 148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */