Localisation, using Locale class

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@113 0fc631ac-6414-0410-93d0-97cfa31319b6

src/util/locale.hpp

@@ -0,0 +1,64 @@
+//+----------------------------------------------------------------------------+
+//| Description:  Magic Set Editor - Program to make Magic (tm) cards          |
+//| Copyright:    (C) 2001 - 2006 Twan van Laarhoven                           |
+//| License:      GNU General Public License 2 or later (see file COPYING)     |
+//+----------------------------------------------------------------------------+
+
+#ifndef HEADER_UTIL_LOCALE
+#define HEADER_UTIL_LOCALE
+
+/** @file util/locale.hpp
+ *
+ *  @brief Utilities for localisation of text.
+ *  Whenever text is used that can be translated to another language (and is not code related)
+ *  one of the macros from this file should be used
+ */
+
+// ----------------------------------------------------------------------------- : Includes
+
+#include <util/prec.hpp>
+#include <util/string.hpp>
+
+// ----------------------------------------------------------------------------- : Localisation macros
+
+enum LocaleCategory
+{	LOCALE_CAT_MENU
+,	LOCALE_CAT_HELP
+,	LOCALE_CAT_TOOL
+,	LOCALE_CAT_LABEL
+,	LOCALE_CAT_BUTTON
+,	LOCALE_CAT_TYPE
+,	LOCALE_CAT_ACTION
+,	LOCALE_CAT_ERROR
+,	LOCALE_CAT_MAX
+};
+
+/// Translate 'key' in the category 'cat' using the current locale
+String tr(LocaleCategory cat, const String& key);
+
+/// A localized string for menus/toolbar buttons
+#define _MENU_(s)	tr(LOCALE_CAT_MENU,  _(s))
+/// A localized string for help/statusbar text
+#define _HELP_(s)	tr(LOCALE_CAT_HELP,  _(s))
+/// A localized string for tooltip text for toolbar buttons
+#define _TOOL_(s)	tr(LOCALE_CAT_TOOL,  _(s))
+/// A localized string for labels
+#define _LABEL_(s)	tr(LOCALE_CAT_LABEL, _(s))
+/// A localized string for buttons
+#define _BUTTON_(s)	tr(LOCALE_CAT_BUTTON,_(s))
+/// A localized string for type names in scripts
+#define _TYPE_(s)	tr(LOCALE_CAT_TYPE,  _(s))
+/// A localized string for action names
+#define _ACTION_(s)	tr(LOCALE_CAT_ACTION, _(s))
+/// A localized string for error messages
+#define _ERROR_(s)	tr(LOCALE_CAT_ERROR, _(s))
+
+/// A localized string for error messages, with 1 argument (printf style)
+#define _ERROR_1_(s,a)		String::Format(tr(LOCALE_CAT_ERROR, _(s)), a)
+/// A localized string for error messages, with 2 argument (printf style)
+#define _ERROR_2_(s,a,b)	String::Format(tr(LOCALE_CAT_ERROR, _(s)), a, b)
+/// A localized string for error messages, with 3 argument (printf style)
+#define _ERROR_3_(s,a,b,c)	String::Format(tr(LOCALE_CAT_ERROR, _(s)), a, b, c)
+
+// ----------------------------------------------------------------------------- : EOF
+#endif