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 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: LabeledDataSequence.idl,v $
  10  * $Revision: 1.3 $
  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 #ifndef com_sun_star_chart2_data_LabeledDataSequence_idl
  31 #define com_sun_star_chart2_data_LabeledDataSequence_idl
  32
  33 #include <com/sun/star/util/XCloneable.idl>
  34 #include <com/sun/star/util/XModifyBroadcaster.idl>
  35
  36 #include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
  37
  38 module com
  39 {
  40 module sun
  41 {
  42 module star
  43 {
  44 module chart2
  45 {
  46 module data
  47 {
  48
  49 /** describes a container for a sequence pair of value-sequences, one
  50     for a label and one for the associated data.
  51   */
  52 service LabeledDataSequence
  53 {
  54     /** provides read- and write-access to the underlying data.
  55      */
  56     interface XLabeledDataSequence;
  57
  58     /** is used to broadcast when the sequence for labels or values
  59         change their identity, or their content changes.
  60
  61         <p>The LabeledDataSequence should add itself at its
  62         XDataSequences for values and labels, and forward any change
  63         events coming from there.</p>
  64      */
  65     interface com::sun::star::util::XModifyBroadcaster;
  66
  67     /** Allows creating copies of data sequences.  If this interface
  68         is not supported, the same object will be shared if used by
  69         multiple objects.
  70
  71         <p>If a <type>LabeledDataSequence</type> is cloned, it has to
  72         query its contents for the
  73         <type scope="com::sun::star::util">XCloneable</type> interface
  74         and use it if available.</p>
  75     */
  76     [optional] interface ::com::sun::star::util::XCloneable;
  77 };
  78
  79 } ; // data
  80 } ; // chart2
  81 } ; // com
  82 } ; // sun
  83 } ; // star
  84
  85
  86 #endif