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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef com_sun_star_chart2_data_LabeledDataSequence_idl
  28 #define com_sun_star_chart2_data_LabeledDataSequence_idl
  29
  30 #include <com/sun/star/util/XCloneable.idl>
  31 #include <com/sun/star/util/XModifyBroadcaster.idl>
  32
  33 #include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
  34
  35 module com
  36 {
  37 module sun
  38 {
  39 module star
  40 {
  41 module chart2
  42 {
  43 module data
  44 {
  45
  46 /** describes a container for a sequence pair of value-sequences, one
  47     for a label and one for the associated data.
  48   */
  49 service LabeledDataSequence
  50 {
  51     /** provides read- and write-access to the underlying data.
  52      */
  53     interface XLabeledDataSequence;
  54
  55     /** is used to broadcast when the sequence for labels or values
  56         change their identity, or their content changes.
  57
  58         <p>The LabeledDataSequence should add itself at its
  59         XDataSequences for values and labels, and forward any change
  60         events coming from there.</p>
  61      */
  62     interface com::sun::star::util::XModifyBroadcaster;
  63
  64     /** Allows creating copies of data sequences.  If this interface
  65         is not supported, the same object will be shared if used by
  66         multiple objects.
  67
  68         <p>If a <type>LabeledDataSequence</type> is cloned, it has to
  69         query its contents for the
  70         <type scope="com::sun::star::util">XCloneable</type> interface
  71         and use it if available.</p>
  72     */
  73     [optional] interface ::com::sun::star::util::XCloneable;
  74 };
  75
  76 } ; // data
  77 } ; // chart2
  78 } ; // com
  79 } ; // sun
  80 } ; // star
  81
  82
  83 #endif