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

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