src/views/rolesaccessor.h

   1 /***************************************************************************
   2  *   Copyright (C) 2010 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef ROLESACCESSOR_H
  21 #define ROLESACCESSOR_H
  22
  23 #include <libdolphin_export.h>
  24
  25 #include <QList>
  26 #include <QHash>
  27
  28 /**
  29  * @brief Allows to access the available roles that can be shown in a view.
  30  */
  31 class LIBDOLPHINPRIVATE_EXPORT RolesAccessor
  32 {
  33 public:
  34     static RolesAccessor& instance();
  35
  36     /**
  37      * @return List of all available roles.
  38      */
  39     QList<QByteArray> roles() const;
  40
  41     /**
  42      * @return Translation of the role that can be shown e.g. in the header
  43      *         of a view or as menu-entry.
  44      */
  45     QString translation(const QByteArray& role) const;
  46
  47 protected:
  48     RolesAccessor();
  49     virtual ~RolesAccessor();
  50     friend class RolesAccessorSingleton;
  51
  52 private:
  53     struct Translation {
  54         const char* const role;
  55         const char* const roleTranslationContext;
  56         const char* const roleTranslation;
  57     };
  58
  59     QList<QByteArray> m_roles;
  60     QHash<QByteArray, const Translation*> m_translation;
  61 };
  62
  63 #endif
  64