src/qml/debugger/qqmldebugservice_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLDEBUGSERVICE_H
  43 #define QQMLDEBUGSERVICE_H
  44
  45 #include <QtCore/qobject.h>
  46
  47 #include <private/qtqmlglobal_p.h>
  48
  49 //
  50 //  W A R N I N G
  51 //  -------------
  52 //
  53 // This file is not part of the Qt API.  It exists purely as an
  54 // implementation detail.  This header file may change from version to
  55 // version without notice, or even be removed.
  56 //
  57 // We mean it.
  58 //
  59
  60 QT_BEGIN_HEADER
  61
  62 QT_BEGIN_NAMESPACE
  63
  64
  65 class QQmlDebugServicePrivate;
  66 class Q_QML_PRIVATE_EXPORT QQmlDebugService : public QObject
  67 {
  68     Q_OBJECT
  69     Q_DECLARE_PRIVATE(QQmlDebugService)
  70     Q_DISABLE_COPY(QQmlDebugService)
  71
  72 public:
  73     explicit QQmlDebugService(const QString &, float version, QObject *parent = 0);
  74     ~QQmlDebugService();
  75
  76     QString name() const;
  77     float version() const;
  78
  79     enum State { NotConnected, Unavailable, Enabled };
  80     State state() const;
  81
  82     void sendMessage(const QByteArray &);
  83     void sendMessages(const QList<QByteArray> &);
  84     bool waitForMessage();
  85
  86     static int idForObject(QObject *);
  87     static QObject *objectForId(int);
  88
  89     static QString objectToString(QObject *obj);
  90
  91     static bool isDebuggingEnabled();
  92     static bool hasDebuggingClient();
  93
  94 protected:
  95     QQmlDebugService(QQmlDebugServicePrivate &dd, const QString &name, float version, QObject *parent = 0);
  96
  97     State registerService();
  98
  99     virtual void stateAboutToBeChanged(State);
 100     virtual void stateChanged(State);
 101     virtual void messageReceived(const QByteArray &);
 102
 103 private:
 104     friend class QQmlDebugServer;
 105     friend class QQmlDebugServerPrivate;
 106 };
 107
 108 QT_END_NAMESPACE
 109
 110 QT_END_HEADER
 111
 112 #endif // QQMLDEBUGSERVICE_H
 113