src/UIState.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_UI_STATE_HPP
  25 #define XCSOAR_UI_STATE_HPP
  26
  27 #include "DisplayMode.hpp"
  28 #include "Util/StaticString.hpp"
  29 #include "PageSettings.hpp"
  30
  31 /**
  32  * The state of the user interface.
  33  */
  34 struct UIState {
  35   /**
  36    * Is the display currently blanked?
  37    */
  38   bool screen_blanked;
  39
  40   /**
  41    * The display mode forced by the user.  If not NONE, it overrides
  42    * the automatic display mode.
  43    */
  44   DisplayMode force_display_mode;
  45
  46   /**
  47    * The effective display mode.
  48    */
  49   DisplayMode display_mode;
  50
  51   /**
  52    * Are the info boxes showing an "auxiliary" set?
  53    */
  54   bool auxiliary_enabled;
  55
  56   /**
  57    * Which "auxiliary" set is visible if #auxiliary_enabled is true?
  58    */
  59   unsigned auxiliary_index;
  60
  61   /**
  62    * The index of the InfoBox panel currently being displayed.  If
  63    * #auxiliary_enabled is true, then this is the same as
  64    * #auxiliary_index.
  65    */
  66   unsigned panel_index;
  67
  68   /**
  69    * A copy of the current InfoBox panel name.  This copy is necessary
  70    * because the original name is in InfoBoxSettings, but MapWindow
  71    * does not know InfoBoxSettings or UISettings, and needs to know
  72    * the name for rendering the overlay.
  73    */
  74   StaticString<32u> panel_name;
  75
  76   /**
  77    * The index of the current page in the list of configured pages,
  78    * see #PageSettings.
  79    *
  80    * This setting is only active if #special_page is not defined.
  81    * Otherwise, it is the page that we will return to after the user
  82    * decides to leave the #special_page.
  83    */
  84   unsigned page_index;
  85
  86   /**
  87    * If this attribute is defined (see PageLayout::IsDefined()), then
  88    * the current page is not the one in #PageSettings, specified by
  89    * #page_index, but a page that was created automatically.  For
  90    * example, it could be a page that was created by clicking on the
  91    * FLARM radar.  Pressing left/right will return to the last
  92    * configured page.
  93    */
  94   PageLayout special_page;
  95
  96   void Clear();
  97 };
  98
  99 #endif