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