lumiera_/src/gui/config-keys.hpp

71 lines
2.3 KiB
C++
Raw Normal View History

/*
CONFIG-KEYS.hpp - magic keys to query the global application configuration
Copyright (C) Lumiera.org
2008, Joel Holdsworth <joel@airwebreathe.org.uk>
2017, Hermann Vosseler <Ichthyostega@web.de>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file config-keys.hpp
** Hard wired key constants to access the global application configuration.
**
** \par configuration and resource search
** The UI layer retrieves the necessary configuration values from lumiera::Config,
** the config facade in the application core. Currently as of 2/2011 these values are
** loaded from setup.ini, because the full-blown config system is not yet implemented.
** Amongst others, this configuration defines a <i>search path</i> for icons and a
** separate search path for resources. These path specs may use the token \c $ORIGIN
** to refer to the installation directory of the currently executing program.
** This allows for a relocatable Lumiera installation bundle.
**
** @see gtk-lumiera.cpp the plugin to pull up this GUI
** @see lumiera::BasicSetup definition of the acceptable configuration values
** @see lumiera::AppState general Lumiera application main
** @see lumiera::Config
**
*/
#ifndef GUI_CONFIG_KEYS_H
#define GUI_CONFIG_KEYS_H
#include "lib/symbol.hpp"
#include "include/config-facade.h"
namespace gui {
using lib::Literal;
using lumiera::Config;
extern Literal KEY_TITLE;
extern Literal KEY_VERSION;
extern Literal KEY_WEBSITE;
extern Literal KEY_AUTHORS;
extern Literal KEY_COPYRIGHT;
extern Literal KEY_STYLESHEET;
extern Literal KEY_UIRES_PATH;
extern Literal KEY_ICON_PATH;
}// namespace gui
#endif /*GUI_CONFIG_KEYS_H*/