util.h

Go to the documentation of this file.

/*
  util.h

  This file is part of GammaRay, the Qt application inspection and
  manipulation tool.

  Copyright (C) 2010-2014 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
  Author: Volker Krause <volker.krause@kdab.com>

  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, see <http://www.gnu.org/licenses/>.
*/
#ifndef GAMMARAY_UTIL_H
#define GAMMARAY_UTIL_H

#include "gammaray_core_export.h"

#include <QString>
#include <QVariant>

class QRect;
class QPainter;
class QObject;

namespace GammaRay {

namespace Util {

  GAMMARAY_CORE_EXPORT QString displayString(const QObject *object);

  GAMMARAY_CORE_EXPORT QString shortDisplayString(const QObject *object);

  GAMMARAY_CORE_EXPORT QString addressToString(const void *p);

  GAMMARAY_CORE_EXPORT QString enumToString(const QVariant &value,
                                       const char *typeName = 0,
                                       const QObject *object = 0);

  template <typename T>
  inline QString enumToString(T value, const char *typeName = 0, const QObject *object = 0)
  {
    return enumToString(QVariant::fromValue<T>(value), typeName, object);
  }

  GAMMARAY_CORE_EXPORT QString prettyMethodSignature(const QMetaMethod &method);

  GAMMARAY_CORE_EXPORT bool descendantOf(const QObject *ascendant, const QObject *object);

  template <typename T>
  T *findParentOfType(QObject *object) {
    if (!object) {
      return 0;
    }
    if (qobject_cast<T*>(object)) {
      return qobject_cast<T*>(object);
    }
    return findParentOfType<T>(object->parent());
  }

  GAMMARAY_CORE_EXPORT QVariant iconForObject(const QObject *object);

  GAMMARAY_CORE_EXPORT QString tooltipForObject(const QObject *object);

  GAMMARAY_CORE_EXPORT void drawTransparencyPattern(QPainter *painter, const QRect &rect, int squareSize = 8);

  GAMMARAY_CORE_EXPORT int signalIndexToMethodIndex(const QMetaObject* metaObject, int signalIndex);
}

}

#endif // GAMMARAY_UTIL_H