offapi/com/sun/star/chart/ChartDataCaption.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_chart_ChartDataCaption_idl__
  28 #define __com_sun_star_chart_ChartDataCaption_idl__
  29
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module chart {
  34
  35 //=============================================================================
  36
  37 /** These values specify how the captions of data points are displayed.
  38  */
  39 published constants ChartDataCaption
  40 {
  41     //-------------------------------------------------------------------------
  42
  43     /** No captions are displayed.
  44      */
  45     const long NONE = 0;
  46
  47     //-------------------------------------------------------------------------
  48
  49     /** The caption contains the value of the data point in the number
  50         format of the axis that is attached to the respective data
  51         series.
  52      */
  53     const long VALUE = 1;
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** The caption contains the value of the data point in percent of
  58         all data points of one category.
  59
  60         <p>That means, if a data point is the first one of a series,
  61         the percentage is calculated by using the first data points of
  62         all available series.</p>
  63      */
  64     const long PERCENT = 2;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** The caption contains the category name of the category to
  69         which a data point belongs.
  70      */
  71     const long TEXT = 4;
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** The number formatter is always used for displaying the value
  76         as value.  So this setting is deprecated.
  77
  78         @deprecated
  79      */
  80     const long FORMAT = 8;
  81
  82     //-------------------------------------------------------------------------
  83
  84     /** The symbol of data column/row is additionally displayed in the caption.
  85      */
  86     const long SYMBOL = 16;
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif