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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 #ifndef com_sun_star_chart2_IncrementData_idl
   3 #define com_sun_star_chart2_IncrementData_idl
   4
   5 #include <com/sun/star/chart2/SubIncrement.idl>
   6
   7 //=============================================================================
   8
   9 module com {  module sun {  module star {  module chart2 {
  10
  11 //=============================================================================
  12
  13 /** An IncrementData describes how tickmarks are positioned on the scale of an axis.
  14
  15 @see <type>Axis</type>
  16 @see <type>Grid</type>
  17 @see <type>Scale</type>
  18 @see <type>XScaling</type>
  19 */
  20 struct IncrementData
  21 {
  22     /** if the any contains a double value this is used as a fixed
  23         Distance value.  Otherwise, if the any is empty or contains an
  24         incompatible type, the Distance is meant to be calculated
  25         automatically by the view component representing the model
  26         containing this increment.
  27      */
  28     any         Distance;
  29
  30     /**
  31     <member>PostEquidistant</member> rules whether the member <member>Distance</member>
  32     describes a distance before or after the scaling is applied.
  33
  34     <p>If <member>PostEquidistant</member> equals <TRUE/> <member>Distance</member>
  35     is given in values after <type>XScaling</type> is applied, thus resulting
  36     main tickmarks will always look equidistant on the screen.
  37     If <member>PostEquidistant</member> equals <FALSE/> <member>Distance</member>
  38     is given in values before <type>XScaling</type> is applied.</p>
  39     */
  40     any         PostEquidistant;
  41
  42     /** if the any contains a double value this is used as a fixed
  43         BaseValue.  Otherwise, if the any is empty or contains an
  44         incompatible type, the BaseValue is meant to be calculated
  45         automatically by the view component representing the model
  46         containing this increment.
  47      */
  48     any         BaseValue;
  49
  50     /** <member>SubIncrements</member> describes the positioning of further
  51     sub tickmarks on the scale of an axis.
  52
  53     <p>The first SubIncrement in this sequence determines how the
  54     distance between two neighboring main tickmarks is divided for positioning
  55     of further sub tickmarks. Every following SubIncrement determines the
  56     positions of subsequent tickmarks in relation to their parent tickmarks
  57     given by the preceding SubIncrement.</p>
  58     */
  59     sequence< SubIncrement > SubIncrements;
  60 };
  61
  62 //=============================================================================
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */