kalzium/libavogadro-kalzium/src/elementtranslate.h

   1 /**********************************************************************
   2   ElementTranslator - Class to handle translation/i18n of element names
   3
   4   Copyright (C) 2007 Geoffrey R. Hutchison
   5
   6   This file is part of the Avogadro molecular editor project.
   7   For more information, see <http://avogadro.sourceforge.net/>
   8
   9   Avogadro is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   Avogadro is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19   You should have received a copy of the GNU General Public License
  20   along with this program; if not, write to the Free Software
  21   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22   02110-1301, USA.
  23  **********************************************************************/
  24
  25 #ifndef __ELEMENTTRANSLATE_H
  26 #define __ELEMENTTRANSLATE_H
  27
  28 #include <avogadro/global.h>
  29
  30 namespace Avogadro {
  31
  32   /**
  33    * This class provides for translation of element names: e.g., tr("Carbon")
  34    *
  35    * @author Geoff Hutchison
  36    */
  37   class A_EXPORT ElementTranslator: public QObject
  38   {
  39     Q_OBJECT
  40
  41   public:
  42     ElementTranslator(): QObject() {}
  43     ~ElementTranslator() {}
  44
  45     /**
  46      * Translate element names.
  47      * @param element The atomic number of the element to be translated
  48      * @return a QString with the appropriate translation for the current locale
  49      */
  50     QString name(int element) const;
  51   };
  52
  53   A_DECL_EXPORT extern ElementTranslator elementTranslator;
  54
  55 }
  56
  57 #endif