offapi/com/sun/star/chart2/DataPointProperties.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef com_sun_star_chart2_DataPointProperties_idl
  29 #define com_sun_star_chart2_DataPointProperties_idl
  30
  31 #include <com/sun/star/beans/PropertySet.idl>
  32 #include <com/sun/star/awt/Gradient.idl>
  33 #include <com/sun/star/style/XStyle.idl>
  34 #include <com/sun/star/drawing/Hatch.idl>
  35 #include <com/sun/star/drawing/LineDash.idl>
  36 #include <com/sun/star/drawing/BitmapMode.idl>
  37 #include <com/sun/star/drawing/FillStyle.idl>
  38 #include <com/sun/star/drawing/LineStyle.idl>
  39 #include <com/sun/star/drawing/RectanglePoint.idl>
  40 #include <com/sun/star/chart2/DataPointLabel.idl>
  41 #include <com/sun/star/chart2/Symbol.idl>
  42
  43 module com
  44 {
  45 module sun
  46 {
  47 module star
  48 {
  49 module chart2
  50 {
  51
  52 service DataPointProperties
  53 {
  54     /** to give access to the properties required by this service.
  55     */
  56     service ::com::sun::star::beans::PropertySet;
  57
  58     // ----------------------------------------------------------------------
  59
  60     /** points to a style that also supports this service (but not
  61         this property) that is used as default, if the PropertyState
  62         of a property is <code>DEFAULT_VALUE</code>.
  63      */
  64 //     [optional, property] ::com::sun::star::style::XStyle        Style;
  65
  66     // Common Properties
  67     // -----------------
  68
  69
  70     /** This is the main color of a data point.
  71
  72         <p>For charts with filled areas, like bar-charts, this should
  73         map to the <code>FillColor</code> of the objects.  For
  74         line-charts this should map to the <code>LineColor</code>
  75         property.</p>
  76
  77         @see com::sun::star::drawing::FillProperties
  78         @see com::sun::star::drawing::LineProperties
  79      */
  80     [property] long                                   Color;
  81
  82     /** This is the main transparency value of a data point.
  83
  84         <p>For charts with filled areas, like bar-charts, this should
  85         map to the <code>FillTransparence</code> of the objects.  For
  86         line-charts this should map to the
  87         <code>LineTransparence</code> property.</p>
  88
  89         @see com::sun::star::drawing::FillProperties
  90         @see com::sun::star::drawing::LineProperties
  91      */
  92     [property] short                                  Transparency;
  93
  94
  95     // Fill Properties
  96     // ---------------
  97
  98     /** This enumeration selects the style with which the area will be filled.
  99     */
 100     [property] ::com::sun::star::drawing::FillStyle   FillStyle;
 101
 102     /** This describes the transparency of the fill area as a gradient.
 103     */
 104     [optional, property] ::com::sun::star::awt::Gradient        TransparencyGradient;
 105     [optional, property] ::com::sun::star::awt::Gradient        Gradient;
 106     [optional, property] ::com::sun::star::drawing::Hatch       Hatch;
 107
 108     [property] string TransparencyGradientName;
 109     [property] string GradientName;
 110     [property] string HatchName;
 111     [property] string FillBitmapName;
 112
 113     /** If <TRUE/>, fills the background of a hatch with the color
 114         given in the <member>Color</member> property.
 115      */
 116     [property] boolean FillBackground;
 117
 118     /** Is used for borders around filled objects.  See
 119         <code>LineColor</code>.
 120
 121         @see com::sun::star::drawing::LineProperties
 122      */
 123     [property] long                                   BorderColor;
 124     /** Is used for borders around filled objects.  See
 125         <code>LineStyle</code>.
 126
 127         @see com::sun::star::drawing::LineProperties
 128      */
 129     [property] ::com::sun::star::drawing::LineStyle   BorderStyle;
 130     /** Is used for borders around filled objects.  See
 131         <code>LineWidth</code>.
 132
 133         @see com::sun::star::drawing::LineProperties
 134      */
 135     [property] long                                   BorderWidth;
 136     /** Is used for borders around filled objects.  See
 137         <code>LineDash</code>.
 138
 139         @see com::sun::star::drawing::LineProperties
 140      */
 141     [property] ::com::sun::star::drawing::LineDash    BorderDash;
 142
 143     /** The name of a dash that can be found in the
 144         <type scope="com::sun::star::container">XNameContainer</type>
 145         "com.sun.star.drawing.LineDashTable", that can be created via
 146         the
 147         <type scope="com::sun::star::uno">XMultiServiceFactory</type>
 148         of the <type>ChartDocument</type>.
 149      */
 150     [optional, property] string                       BorderDashName;
 151
 152     /** Is used for borders around filled objects.  See
 153         <code>LineTransparence</code>.
 154
 155         @see com::sun::star::drawing::LineProperties
 156      */
 157     [optional, property] short                        BorderTransparency;
 158
 159
 160     // Line Properties
 161     // ---------------
 162     [property] ::com::sun::star::drawing::LineStyle   LineStyle;
 163     /** Is only used for line-chart types.
 164
 165         @see com::sun::star::drawing::LineProperties
 166      */
 167     [property] long                                   LineWidth;
 168     /** Is only used for line-chart types.
 169
 170         @see com::sun::star::drawing::LineProperties
 171      */
 172     [property] ::com::sun::star::drawing::LineDash    LineDash;
 173
 174     /** The name of a dash that can be found in the
 175         <type scope="com::sun::star::container">XNameContainer</type>
 176         "com.sun.star.drawing.LineDashTable", that can be created via
 177         the
 178         <type scope="com::sun::star::uno">XMultiServiceFactory</type>
 179         of the <type>ChartDocument</type>.
 180      */
 181     [optional, property] string                       LineDashName;
 182
 183     //-------------------------------------------------------------------------
 184
 185     // bitmap properties /copied from drawing::FillProperties
 186
 187     /** This is the horizontal offset where the tile starts.
 188
 189         <p>It is given in percent in relation to the width of the bitmap.
 190     */
 191     [property] short FillBitmapOffsetX;
 192
 193     /** This is the vertical offset where the tile starts.
 194
 195         It is given in percent in relation to the width of the bitmap.
 196     */
 197     [property] short FillBitmapOffsetY;
 198
 199     /** Every second line of tiles is moved the given percent of the
 200         width of the bitmap.
 201     */
 202     [property] short FillBitmapPositionOffsetX;
 203
 204     /** Every second row of tiles is moved the given percent of the
 205         width of the bitmap.
 206     */
 207     [property] short FillBitmapPositionOffsetY;
 208
 209     /** The RectanglePoint specifies the position inside of the bitmap to
 210         use as the top left position for rendering.
 211     */
 212     [property] com::sun::star::drawing::RectanglePoint FillBitmapRectanglePoint;
 213
 214     /** specifies if the size is given in percentage or
 215         as an absolute value.
 216
 217         <p>If this is <TRUE/>, the properties FillBitmapSizeX
 218         and  FillBitmapSizeY contain the size of the tile in percent
 219         of the size of the original bitmap. If this
 220         is <FALSE/>, the size of the tile is specified
 221         with 1/100th mm.
 222     */
 223     [property] boolean FillBitmapLogicalSize;
 224
 225     /** This is the width of the tile for filling.
 226
 227         <p>Depending on the property FillBitmapLogicalSize, this is
 228         either relative or absolute.
 229     */
 230     [property] long FillBitmapSizeX;
 231
 232     /** This is the height of the tile for filling.
 233
 234         <p>Depending on the property FillBitmapLogicalSize, this
 235         is either relative or absolute.
 236     */
 237     [property] long FillBitmapSizeY;
 238
 239     /** this enum selects how a area is filled with a single bitmap.
 240     */
 241     [property] com::sun::star::drawing::BitmapMode FillBitmapMode;
 242
 243     //-------------------------------------------------------------------------
 244
 245     /**
 246      */
 247     [optional, property] Symbol                       Symbol;
 248
 249     /** describes a value by which a data point is moved from its
 250         default position in percent of the maximum allowed distance.
 251
 252         <p>This is especially useful for the explosion of pie-chart
 253         segments.</p>
 254      */
 255     [optional, property] double                       Offset;
 256
 257     /** describes the geometry of a 3 dimensional data point.
 258         Number is one of constant group <type>DataPointGeometry3D</type>.
 259         <p>This is especially used for 3D bar-charts.</p>
 260         <p>CUBOID==0 CYLINDER==1 CONE==2 PYRAMID==3 CUBOID==else</p>
 261     */
 262     [optional, property] long                         Geometry3D;
 263
 264     [property] DataPointLabel                         Label;
 265
 266     /** specifies a string that is used to separate the parts of a data label (caption)
 267      */
 268     [optional, property] string LabelSeparator;
 269
 270     /** specifies a number format for the display of the value in the data label
 271      */
 272     [optional, property] long NumberFormat;
 273
 274     /** specifies a number format for the display of the percentage value in the data label
 275      */
 276     [optional, property] long PercentageNumberFormat;
 277
 278     /** specifies a relative position for the data label
 279
 280         @see ::com::sun::star::chart::DataLabelPlacement
 281      */
 282     [optional, property] long LabelPlacement;
 283
 284     /** The size of the page at the moment when the font size for
 285         data labels was set.
 286
 287         <p>This size is used to resize text in the view when the size
 288         of the page has changed since the font sizes were set
 289         (automatic text scaling).</p>
 290      */
 291     [maybevoid, property] com::sun::star::awt::Size   ReferencePageSize;
 292
 293     // statistics
 294
 295     /** If void, no error bars are shown for the data point in
 296         x-direction.
 297
 298         <p>The <type scope="com::sun::star::beans">XPropertySet</type>
 299         must support the service <type>ErrorBar</type>.</p>
 300      */
 301     [optional, maybevoid, property] com::sun::star::beans::XPropertySet      ErrorBarX;
 302
 303     /** If void, no error bars are shown for the data point in
 304         y-direction.
 305
 306         <p>The <type scope="com::sun::star::beans">XPropertySet</type>
 307         must support the service <type>ErrorBar</type>.</p>
 308      */
 309     [optional, maybevoid, property] com::sun::star::beans::XPropertySet      ErrorBarY;
 310
 311     /** In case <member>ErrorBarX</member> and
 312         <member>ErrorBarY</member> both are set, and error bars are
 313         shown, a box spanning all error-indicators is rendered.
 314      */
 315     [optional, maybevoid, property] boolean           ShowErrorBox;
 316
 317
 318     /** A value between 0 and 100 indicating the percentage how round an edge should be.
 319     */
 320     [optional, maybevoid, property] short             PercentDiagonal;
 321 };
 322
 323 } ; // chart2
 324 } ; // com
 325 } ; // sun
 326 } ; // star
 327
 328
 329 #endif
 330
 331 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */