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
  21 module com {  module sun {  module star {  module chart2 {
  22
  23
  24 /** An IncrementData describes how tickmarks are positioned on the scale of an axis.
  25
  26 @see Axis
  27 @see Grid
  28 @see Scale
  29 @see XScaling
  30 */
  31 struct IncrementData
  32 {
  33     /** if the any contains a double value this is used as a fixed
  34         Distance value.  Otherwise, if the any is empty or contains an
  35         incompatible type, the Distance is meant to be calculated
  36         automatically by the view component representing the model
  37         containing this increment.
  38      */
  39     any         Distance;
  40
  41     /**
  42     #PostEquidistant rules whether the member #Distance
  43     describes a distance before or after the scaling is applied.
  44
  45     <p>If #PostEquidistant equals `TRUE` #Distance
  46     is given in values after XScaling is applied, thus resulting
  47     main tickmarks will always look equidistant on the screen.
  48     If #PostEquidistant equals `FALSE` #Distance
  49     is given in values before XScaling is applied.</p>
  50     */
  51     any         PostEquidistant;
  52
  53     /** if the any contains a double value this is used as a fixed
  54         BaseValue.  Otherwise, if the any is empty or contains an
  55         incompatible type, the BaseValue is meant to be calculated
  56         automatically by the view component representing the model
  57         containing this increment.
  58      */
  59     any         BaseValue;
  60
  61     /** #SubIncrements describes the positioning of further
  62     sub tickmarks on the scale of an axis.
  63
  64     <p>The first SubIncrement in this sequence determines how the
  65     distance between two neighboring main tickmarks is divided for positioning
  66     of further sub tickmarks. Every following SubIncrement determines the
  67     positions of subsequent tickmarks in relation to their parent tickmarks
  68     given by the preceding SubIncrement.</p>
  69     */
  70     sequence< SubIncrement > SubIncrements;
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */