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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef com_sun_star_chart2_IncrementData_idl
  21 #define com_sun_star_chart2_IncrementData_idl
  22
  23 #include <com/sun/star/chart2/SubIncrement.idl>
  24
  25
  26 module com {  module sun {  module star {  module chart2 {
  27
  28
  29 /** An IncrementData describes how tickmarks are positioned on the scale of an axis.
  30
  31 @see Axis
  32 @see Grid
  33 @see Scale
  34 @see XScaling
  35 */
  36 struct IncrementData
  37 {
  38     /** if the any contains a double value this is used as a fixed
  39         Distance value.  Otherwise, if the any is empty or contains an
  40         incompatible type, the Distance is meant to be calculated
  41         automatically by the view component representing the model
  42         containing this increment.
  43      */
  44     any         Distance;
  45
  46     /**
  47     #PostEquidistant rules whether the member #Distance
  48     describes a distance before or after the scaling is applied.
  49
  50     <p>If #PostEquidistant equals `TRUE` #Distance
  51     is given in values after XScaling is applied, thus resulting
  52     main tickmarks will always look equidistant on the screen.
  53     If #PostEquidistant equals `FALSE` #Distance
  54     is given in values before XScaling is applied.</p>
  55     */
  56     any         PostEquidistant;
  57
  58     /** if the any contains a double value this is used as a fixed
  59         BaseValue.  Otherwise, if the any is empty or contains an
  60         incompatible type, the BaseValue is meant to be calculated
  61         automatically by the view component representing the model
  62         containing this increment.
  63      */
  64     any         BaseValue;
  65
  66     /** #SubIncrements describes the positioning of further
  67     sub tickmarks on the scale of an axis.
  68
  69     <p>The first SubIncrement in this sequence determines how the
  70     distance between two neighboring main tickmarks is divided for positioning
  71     of further sub tickmarks. Every following SubIncrement determines the
  72     positions of subsequent tickmarks in relation to their parent tickmarks
  73     given by the preceding SubIncrement.</p>
  74     */
  75     sequence< SubIncrement > SubIncrements;
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */