util.h

   1 /*
   2   util.h
   3
   4   This file is part of GammaRay, the Qt application inspection and
   5   manipulation tool.
   6
   7   Copyright (C) 2010-2011 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
   8   Author: Volker Krause <volker.krause@kdab.com>
   9
  10   This program is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU General Public License as published by
  12   the Free Software Foundation, either version 2 of the License, or
  13   (at your option) any later version.
  14
  15   This program is distributed in the hope that it will be useful,
  16   but WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18   GNU General Public License for more details.
  19
  20   You should have received a copy of the GNU General Public License
  21   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22 */
  23
  24 #ifndef GAMMARAY_UTIL_H
  25 #define GAMMARAY_UTIL_H
  26
  27 #include <QtCore/QString>
  28 #include <QtCore/QVariant>
  29
  30 class QObject;
  31
  32 namespace GammaRay {
  33
  34 namespace Util
  35 {
  36   QString displayString(const QObject *object);
  37   QString variantToString(const QVariant &value);
  38   /// Returns a value representing @p value in a itemview decoration role
  39   QVariant decorationForVariant(const QVariant &value);
  40   QString addressToString(const void *p);
  41   QString addressToUid(const void *p);
  42
  43   /**
  44    * Translates an enum or flag value into a human readable text.
  45    * @param value The numerical value. Type information from the QVariant
  46    *              are used to find the corresponding QMetaEnum.
  47    * @param typeName Use this if the @p value has type int
  48    *                 (e.g. the case for QMetaProperty::read).
  49    * @param object Additional QObject to search for QMetaEnums.
  50    */
  51   QString enumToString(const QVariant &value, const char *typeName = 0, QObject *object = 0);
  52
  53   bool descendantOf(QObject *ascendant, QObject *obj);
  54
  55   template <typename T>
  56   T *findParentOfType(QObject *object) {
  57     if (!object) {
  58       return 0;
  59     }
  60     if (qobject_cast<T*>(object)) {
  61       return qobject_cast<T*>(object);
  62     }
  63     return findParentOfType<T>(object->parent());
  64   }
  65
  66   /// Returns an icon for the given object.
  67   QVariant iconForObject(QObject *obj);
  68 }
  69
  70 }
  71
  72 #endif // GAMMARAY_UTIL_H