src/StatusMessage.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_STATUS_MESSAGE_H
  25 #define XCSOAR_STATUS_MESSAGE_H
  26
  27 #include "Util/StaticArray.hpp"
  28
  29 #include <tchar.h>
  30
  31 class TLineReader;
  32
  33 /**
  34  * Struct used to store status message items
  35  */
  36 struct StatusMessage {
  37   /** English key */
  38   const TCHAR *key;
  39
  40   /** What sound entry to play */
  41   const TCHAR *sound;
  42
  43   bool visible;
  44
  45   /** Delay for DoStatusMessage */
  46   unsigned delay_ms;
  47
  48   void Clear() {
  49     key = NULL;
  50     sound = NULL;
  51     delay_ms = 2500;
  52     visible = true;
  53   }
  54
  55   bool IsEmpty() const {
  56     return key == NULL;
  57   }
  58 };
  59
  60 /**
  61  * Class to manage a list of active and recent status messages
  62  */
  63 class StatusMessageList {
  64   StaticArray<StatusMessage, 1000> list;
  65   int old_delay;
  66
  67 public:
  68   StatusMessageList();
  69
  70   void LoadFile();
  71   void LoadFile(TLineReader &reader);
  72
  73   void Startup(bool first);
  74
  75   const StatusMessage &First() const {
  76     return list[0];
  77   }
  78
  79   const StatusMessage *Find(const TCHAR *key) const;
  80 };
  81
  82 #endif