src/InfoBoxes/Data.hpp

   1 /*
   2 Copyright_License {
   3
   4   XCSoar Glide Computer - http://www.xcsoar.org/
   5   Copyright (C) 2000-2013 The XCSoar Project
   6   A detailed list of copyright holders can be found in the file "AUTHORS".
   7
   8   This program is free software; you can redistribute it and/or
   9   modify it under the terms of the GNU General Public License
  10   as published by the Free Software Foundation; either version 2
  11   of the License, or (at your option) any later version.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18   You should have received a copy of the GNU General Public License
  19   along with this program; if not, write to the Free Software
  20   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21 }
  22 */
  23
  24 #ifndef XCSOAR_INFO_BOX_DATA_HPP
  25 #define XCSOAR_INFO_BOX_DATA_HPP
  26
  27 #include "Util/StaticString.hpp"
  28 #include "Units/Unit.hpp"
  29 #include "Math/fixed.hpp"
  30
  31 #include <tchar.h>
  32
  33 class Angle;
  34
  35 struct InfoBoxData {
  36   static constexpr unsigned COLOR_COUNT = 6;
  37
  38   StaticString<32> title;
  39   StaticString<32> value;
  40   StaticString<32> comment;
  41
  42   Unit value_unit;
  43
  44   uint8_t title_color, value_color, comment_color;
  45
  46   void Clear();
  47
  48   /**
  49    * Enable custom painting via InfoBoxContent::OnCustomPaint().
  50    */
  51   void SetCustom() {
  52     /* 0xff is a "magic" value that indicates custom painting*/
  53     value_color = 0xff;
  54     value.clear();
  55   }
  56
  57   bool GetCustom() const {
  58     return value_color == 0xff;
  59   }
  60
  61   /**
  62    * Resets value to --- and unassigns the unit
  63    */
  64   void SetValueInvalid();
  65
  66   /**
  67    * Clears comment
  68    */
  69   void SetCommentInvalid() {
  70     comment.clear();
  71   }
  72
  73   /**
  74    * calls SetValueInvalid() then SetCommentInvalid()
  75    */
  76   void SetInvalid();
  77
  78   /**
  79    * Sets the InfoBox title to the given Value
  80    *
  81    * @param title New value of the InfoBox title
  82    */
  83   void SetTitle(const TCHAR *title);
  84
  85   const TCHAR *GetTitle() const {
  86     return title;
  87   };
  88
  89   /**
  90    * Sets the InfoBox value to the given Value
  91    * @param Value New value of the InfoBox value
  92    */
  93   void SetValue(const TCHAR *value);
  94
  95   void SetValue(const TCHAR *format, fixed value);
  96
  97   /**
  98    * Sets the InfoBox value to the given angle.
  99    */
 100   void SetValue(Angle value, const TCHAR *suffix=_T(""));
 101
 102   void SetValueFromBearingDifference(Angle delta);
 103
 104   /**
 105    * Set the InfoBox value to the specified glide ratio.
 106    */
 107   void SetValueFromGlideRatio(fixed gr);
 108
 109   /**
 110    * Set the InfoBox value to the specified distance.
 111    */
 112   void SetValueFromDistance(fixed value);
 113
 114   /**
 115    * Set the InfoBox value to the specified altitude.
 116    */
 117   void SetValueFromAltitude(fixed value);
 118
 119   /**
 120    * Set the InfoBox value to the specified arrival altitude.
 121    */
 122   void SetValueFromArrival(fixed value);
 123
 124   /**
 125    * Set the InfoBox value to the specified horizontal speed.
 126    */
 127   void SetValueFromSpeed(fixed value, bool precision=true);
 128
 129   /**
 130    * Sets the InfoBox comment to the given Value
 131    * @param Value New value of the InfoBox comment
 132    */
 133   void SetComment(const TCHAR *comment);
 134
 135   /**
 136    * Sets the InfoBox comment to the given angle.
 137    */
 138   void SetComment(Angle comment, const TCHAR *suffix=_T(""));
 139
 140   void SetCommentFromDistance(fixed value);
 141
 142   void SetCommentFromBearingDifference(Angle delta);
 143
 144   /**
 145    * Set the InfoBox comment to the specified horizontal speed.
 146    */
 147   void SetCommentFromSpeed(fixed value, bool precision=true);
 148
 149   /**
 150    * Set the InfoBox value to the specified altitude in the alternate
 151    * altitude unit.
 152    */
 153   void SetCommentFromAlternateAltitude(fixed value);
 154
 155   /**
 156    * Set the InfoBox comment value to the specified vertical speed.
 157    */
 158   void SetCommentFromVerticalSpeed(fixed value, bool include_sign=true);
 159
 160   template<typename... Args>
 161   void FormatTitle(const TCHAR *fmt, Args&&... args) {
 162     title.Format(fmt, args...);
 163     title.CropIncompleteUTF8();
 164   }
 165
 166   template<typename... Args>
 167   void FormatValue(const TCHAR *fmt, Args&&... args) {
 168     value.Format(fmt, args...);
 169   }
 170
 171   template<typename... Args>
 172   void FormatComment(const TCHAR *fmt, Args&&... args) {
 173     comment.Format(fmt, args...);
 174     comment.CropIncompleteUTF8();
 175   }
 176
 177   template<typename... Args>
 178   void UnsafeFormatValue(const TCHAR *fmt, Args&&... args) {
 179     value.UnsafeFormat(fmt, args...);
 180   }
 181
 182   template<typename... Args>
 183   void UnsafeFormatComment(const TCHAR *fmt, Args&&... args) {
 184     comment.UnsafeFormat(fmt, args...);
 185   }
 186
 187   /**
 188    * Sets the unit of the InfoBox value
 189    *
 190    * @param Value New unit of the InfoBox value
 191    */
 192   void SetValueUnit(Unit _value_unit) {
 193     value_unit = _value_unit;
 194   }
 195
 196   /**
 197    * Sets the color of the InfoBox value to the given value
 198    * @param value New color of the InfoBox value
 199    */
 200   void SetValueColor(unsigned _color) {
 201     assert(_color < COLOR_COUNT);
 202
 203     value_color = _color;
 204   }
 205
 206   /**
 207    * Sets the color of the InfoBox comment to the given value
 208    * @param value New color of the InfoBox comment
 209    */
 210   void SetCommentColor(unsigned _color) {
 211     assert(_color < COLOR_COUNT);
 212
 213     comment_color = _color;
 214   }
 215
 216   /**
 217    * Sets the color of the InfoBox title to the given value
 218    * @param value New color of the InfoBox title
 219    */
 220   void SetTitleColor(unsigned _color) {
 221     assert(_color < COLOR_COUNT);
 222
 223     title_color = _color;
 224   }
 225
 226   void SetAllColors(unsigned color);
 227
 228   bool CompareTitle(const InfoBoxData &other) const;
 229   bool CompareValue(const InfoBoxData &other) const;
 230   bool CompareComment(const InfoBoxData &other) const;
 231 };
 232
 233 #endif