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