sc/inc/SparklineAttributes.hxx

   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  */
  10
  11 #pragma once
  12
  13 #include "scdllapi.h"
  14 #include <sal/types.h>
  15 #include <tools/color.hxx>
  16 #include <docmodel/color/ComplexColor.hxx>
  17 #include <optional>
  18 #include <o3tl/cow_wrapper.hxx>
  19
  20 namespace sc
  21 {
  22 /** Supported sparkline types */
  23 enum class SparklineType
  24 {
  25     Line,
  26     Column,
  27     Stacked
  28 };
  29
  30 /** The method of calculating the axis min or max value */
  31 enum class AxisType
  32 {
  33     Individual, // calculate the min/max of a sparkline
  34     Group, // calculate the min or max of the whole sparkline group
  35     Custom // user defined
  36 };
  37
  38 /** Determines how to display the empty cells */
  39 enum class DisplayEmptyCellsAs
  40 {
  41     Span,
  42     Gap,
  43     Zero // empty cell equals zero
  44 };
  45
  46 /** Common properties for a group of sparklines */
  47 class SC_DLLPUBLIC SparklineAttributes
  48 {
  49 private:
  50     class Implementation;
  51     o3tl::cow_wrapper<Implementation> m_aImplementation;
  52
  53 public:
  54     SparklineAttributes();
  55     ~SparklineAttributes();
  56     SparklineAttributes(const SparklineAttributes& rOther);
  57     SparklineAttributes(SparklineAttributes&& rOther);
  58     SparklineAttributes& operator=(const SparklineAttributes& rOther);
  59     SparklineAttributes& operator=(SparklineAttributes&& rOther);
  60
  61     bool operator==(const SparklineAttributes& rOther) const;
  62     bool operator!=(const SparklineAttributes& rOther) const
  63     {
  64         return !(SparklineAttributes::operator==(rOther));
  65     }
  66
  67     void resetColors();
  68
  69     model::ComplexColor getColorSeries() const;
  70     void setColorSeries(model::ComplexColor const& rColorSeries);
  71
  72     model::ComplexColor getColorNegative() const;
  73     void setColorNegative(model::ComplexColor const& rColorSeries);
  74
  75     model::ComplexColor getColorAxis() const;
  76     void setColorAxis(model::ComplexColor const& rColorSeries);
  77
  78     model::ComplexColor getColorMarkers() const;
  79     void setColorMarkers(model::ComplexColor const& rColorSeries);
  80
  81     model::ComplexColor getColorFirst() const;
  82     void setColorFirst(model::ComplexColor const& rColorSeries);
  83
  84     model::ComplexColor getColorLast() const;
  85     void setColorLast(model::ComplexColor const& rColorSeries);
  86
  87     model::ComplexColor getColorHigh() const;
  88     void setColorHigh(model::ComplexColor const& rColorSeries);
  89
  90     model::ComplexColor getColorLow() const;
  91     void setColorLow(model::ComplexColor const& rColorSeries);
  92
  93     AxisType getMinAxisType() const;
  94     void setMinAxisType(AxisType eAxisType);
  95
  96     AxisType getMaxAxisType() const;
  97     void setMaxAxisType(AxisType eAxisType);
  98
  99     /** Line weight or width in points */
 100     double getLineWeight() const;
 101     void setLineWeight(double nWeight);
 102
 103     SparklineType getType() const;
 104     void setType(SparklineType eType);
 105
 106     bool isDateAxis() const;
 107     void setDateAxis(bool bValue);
 108
 109     DisplayEmptyCellsAs getDisplayEmptyCellsAs() const;
 110     void setDisplayEmptyCellsAs(DisplayEmptyCellsAs eValue);
 111
 112     bool isMarkers() const;
 113     void setMarkers(bool bValue);
 114
 115     bool isHigh() const;
 116     void setHigh(bool bValue);
 117
 118     bool isLow() const;
 119     void setLow(bool bValue);
 120
 121     bool isFirst() const;
 122     void setFirst(bool bValue);
 123
 124     bool isLast() const;
 125     void setLast(bool bValue);
 126
 127     bool isNegative() const;
 128     void setNegative(bool bValue);
 129
 130     bool shouldDisplayXAxis() const;
 131     void setDisplayXAxis(bool bValue);
 132
 133     bool shouldDisplayHidden() const;
 134     void setDisplayHidden(bool bValue);
 135
 136     bool isRightToLeft() const;
 137     void setRightToLeft(bool bValue);
 138
 139     std::optional<double> getManualMax() const;
 140     void setManualMax(std::optional<double> aValue);
 141
 142     std::optional<double> getManualMin() const;
 143     void setManualMin(std::optional<double> aValue);
 144 };
 145
 146 } // end sc
 147
 148 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */