src/UIGlobals.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_GLOBALS_HPP
  25 #define XCSOAR_UI_GLOBALS_HPP
  26
  27 #include "Compiler.h"
  28
  29 class SingleWindow;
  30 class GlueMapWindow;
  31 struct DialogSettings;
  32 struct Look;
  33 struct DialogLook;
  34 struct IconLook;
  35 struct MapLook;
  36
  37 /**
  38  * This namespace provides helper functions to access generic global
  39  * UI objects.  Use them when you don't know where else to get them.
  40  * This is a last resort only, don't use it if you have a better way
  41  * to do it.
  42  *
  43  * This namespace exists to avoid direct access to #CommonInterface
  44  * and #MainWindow, because that would mean the code is not reusable
  45  * in other applications, while the functions in this namespace can
  46  * easily be replaced in another program.
  47  */
  48 namespace UIGlobals {
  49   gcc_const
  50   SingleWindow &GetMainWindow();
  51
  52   gcc_const
  53   GlueMapWindow *GetMap();
  54
  55   gcc_pure
  56   GlueMapWindow *GetMapIfActive();
  57
  58   gcc_const
  59   const DialogSettings &GetDialogSettings();
  60
  61   gcc_const
  62   const Look &GetLook();
  63
  64   gcc_const
  65   const DialogLook &GetDialogLook();
  66
  67   gcc_const
  68   const IconLook &GetIconLook();
  69
  70   gcc_const
  71   const MapLook &GetMapLook();
  72 };
  73
  74 #endif