qqmlproperty.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2016 The Qt Company Ltd.
  4. ** Contact: https://www.qt.io/licensing/
  5. **
  6. ** This file is part of the QtQml module of the Qt Toolkit.
  7. **
  8. ** $QT_BEGIN_LICENSE:LGPL$
  9. ** Commercial License Usage
  10. ** Licensees holding valid commercial Qt licenses may use this file in
  11. ** accordance with the commercial license agreement provided with the
  12. ** Software or, alternatively, in accordance with the terms contained in
  13. ** a written agreement between you and The Qt Company. For licensing terms
  14. ** and conditions see https://www.qt.io/terms-conditions. For further
  15. ** information use the contact form at https://www.qt.io/contact-us.
  16. **
  17. ** GNU Lesser General Public License Usage
  18. ** Alternatively, this file may be used under the terms of the GNU Lesser
  19. ** General Public License version 3 as published by the Free Software
  20. ** Foundation and appearing in the file LICENSE.LGPL3 included in the
  21. ** packaging of this file. Please review the following information to
  22. ** ensure the GNU Lesser General Public License version 3 requirements
  23. ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
  24. **
  25. ** GNU General Public License Usage
  26. ** Alternatively, this file may be used under the terms of the GNU
  27. ** General Public License version 2.0 or (at your option) the GNU General
  28. ** Public license version 3 or any later version approved by the KDE Free
  29. ** Qt Foundation. The licenses are as published by the Free Software
  30. ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
  31. ** included in the packaging of this file. Please review the following
  32. ** information to ensure the GNU General Public License requirements will
  33. ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
  34. ** https://www.gnu.org/licenses/gpl-3.0.html.
  35. **
  36. ** $QT_END_LICENSE$
  37. **
  38. ****************************************************************************/
  39. #ifndef QQMLPROPERTY_H
  40. #define QQMLPROPERTY_H
  41. #include <QtQml/qtqmlglobal.h>
  42. #include <QtCore/qmetaobject.h>
  43. QT_BEGIN_NAMESPACE
  44. class QObject;
  45. class QVariant;
  46. class QQmlContext;
  47. class QQmlEngine;
  48. class QQmlPropertyPrivate;
  49. class Q_QML_EXPORT QQmlProperty
  50. {
  51. public:
  52. enum PropertyTypeCategory {
  53. InvalidCategory,
  54. List,
  55. Object,
  56. Normal
  57. };
  58. enum Type {
  59. Invalid,
  60. Property,
  61. SignalProperty
  62. };
  63. QQmlProperty();
  64. ~QQmlProperty();
  65. QQmlProperty(QObject *);
  66. QQmlProperty(QObject *, QQmlContext *);
  67. QQmlProperty(QObject *, QQmlEngine *);
  68. QQmlProperty(QObject *, const QString &);
  69. QQmlProperty(QObject *, const QString &, QQmlContext *);
  70. QQmlProperty(QObject *, const QString &, QQmlEngine *);
  71. QQmlProperty(const QQmlProperty &);
  72. QQmlProperty &operator=(const QQmlProperty &);
  73. bool operator==(const QQmlProperty &) const;
  74. Type type() const;
  75. bool isValid() const;
  76. bool isProperty() const;
  77. bool isSignalProperty() const;
  78. int propertyType() const;
  79. PropertyTypeCategory propertyTypeCategory() const;
  80. const char *propertyTypeName() const;
  81. QString name() const;
  82. QVariant read() const;
  83. static QVariant read(const QObject *, const QString &);
  84. static QVariant read(const QObject *, const QString &, QQmlContext *);
  85. static QVariant read(const QObject *, const QString &, QQmlEngine *);
  86. bool write(const QVariant &) const;
  87. static bool write(QObject *, const QString &, const QVariant &);
  88. static bool write(QObject *, const QString &, const QVariant &, QQmlContext *);
  89. static bool write(QObject *, const QString &, const QVariant &, QQmlEngine *);
  90. bool reset() const;
  91. bool hasNotifySignal() const;
  92. bool needsNotifySignal() const;
  93. bool connectNotifySignal(QObject *dest, const char *slot) const;
  94. bool connectNotifySignal(QObject *dest, int method) const;
  95. bool isWritable() const;
  96. bool isDesignable() const;
  97. bool isResettable() const;
  98. QObject *object() const;
  99. int index() const;
  100. QMetaProperty property() const;
  101. QMetaMethod method() const;
  102. private:
  103. friend class QQmlPropertyPrivate;
  104. QQmlPropertyPrivate *d;
  105. };
  106. typedef QList<QQmlProperty> QQmlProperties;
  107. inline uint qHash (const QQmlProperty &key)
  108. {
  109. return qHash(key.object()) + qHash(key.name());
  110. }
  111. Q_DECLARE_TYPEINFO(QQmlProperty, Q_MOVABLE_TYPE);
  112. QT_END_NAMESPACE
  113. #endif // QQMLPROPERTY_H