qquickitem.sip 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. // qquickitem.sip generated by MetaSIP
  2. //
  3. // This file is part of the QtQuick Python extension module.
  4. //
  5. // Copyright (c) 2026 Riverbank Computing Limited <info@riverbankcomputing.com>
  6. //
  7. // This file is part of PyQt6.
  8. //
  9. // This file may be used under the terms of the GNU General Public License
  10. // version 3.0 as published by the Free Software Foundation and appearing in
  11. // the file LICENSE included in the packaging of this file. Please review the
  12. // following information to ensure the GNU General Public License version 3.0
  13. // requirements will be met: http://www.gnu.org/copyleft/gpl.html.
  14. //
  15. // If you do not wish to use this file under the terms of the GPL version 3.0
  16. // then you may purchase a commercial license. For more information contact
  17. // info@riverbankcomputing.com.
  18. //
  19. // This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  20. // WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  21. class QQuickItem : public QObject, public QQmlParserStatus /ExportDerived/
  22. {
  23. %TypeHeaderCode
  24. #include <qquickitem.h>
  25. %End
  26. public:
  27. enum Flag /BaseType=Flag/
  28. {
  29. ItemClipsChildrenToShape,
  30. ItemAcceptsInputMethod,
  31. ItemIsFocusScope,
  32. ItemHasContents,
  33. ItemAcceptsDrops,
  34. %If (Qt_6_3_0 -)
  35. ItemIsViewport,
  36. %End
  37. %If (Qt_6_3_0 -)
  38. ItemObservesViewport,
  39. %End
  40. };
  41. typedef QFlags<QQuickItem::Flag> Flags;
  42. enum ItemChange
  43. {
  44. ItemChildAddedChange,
  45. ItemChildRemovedChange,
  46. ItemSceneChange,
  47. ItemVisibleHasChanged,
  48. ItemParentHasChanged,
  49. ItemOpacityHasChanged,
  50. ItemActiveFocusHasChanged,
  51. ItemRotationHasChanged,
  52. ItemAntialiasingHasChanged,
  53. ItemDevicePixelRatioHasChanged,
  54. ItemEnabledHasChanged,
  55. %If (Qt_6_9_0 -)
  56. ItemScaleHasChanged,
  57. %End
  58. %If (Qt_6_9_0 -)
  59. ItemTransformHasChanged,
  60. %End
  61. };
  62. struct ItemChangeData
  63. {
  64. %TypeHeaderCode
  65. #include <qquickitem.h>
  66. %End
  67. ItemChangeData(QQuickItem *v);
  68. ItemChangeData(QQuickWindow *v);
  69. ItemChangeData(qreal v /Constrained/);
  70. ItemChangeData(bool v /Constrained/);
  71. QQuickItem *item;
  72. QQuickWindow *window;
  73. qreal realValue;
  74. bool boolValue;
  75. };
  76. enum TransformOrigin
  77. {
  78. TopLeft,
  79. Top,
  80. TopRight,
  81. Left,
  82. Center,
  83. Right,
  84. BottomLeft,
  85. Bottom,
  86. BottomRight,
  87. };
  88. explicit QQuickItem(QQuickItem *parent /TransferThis/ = 0);
  89. virtual ~QQuickItem();
  90. QQuickWindow *window() const;
  91. QQuickItem *parentItem() const;
  92. void setParentItem(QQuickItem *parent);
  93. void stackBefore(const QQuickItem *);
  94. void stackAfter(const QQuickItem *);
  95. QRectF childrenRect();
  96. QList<QQuickItem *> childItems() const;
  97. bool clip() const;
  98. void setClip(bool);
  99. QString state() const;
  100. void setState(const QString &);
  101. qreal baselineOffset() const;
  102. void setBaselineOffset(qreal);
  103. qreal x() const;
  104. qreal y() const;
  105. void setX(qreal);
  106. void setY(qreal);
  107. qreal width() const;
  108. void setWidth(qreal);
  109. void resetWidth();
  110. void setImplicitWidth(qreal);
  111. qreal implicitWidth() const;
  112. qreal height() const;
  113. void setHeight(qreal);
  114. void resetHeight();
  115. void setImplicitHeight(qreal);
  116. qreal implicitHeight() const;
  117. void setSize(const QSizeF &size);
  118. QQuickItem::TransformOrigin transformOrigin() const;
  119. void setTransformOrigin(QQuickItem::TransformOrigin);
  120. qreal z() const;
  121. void setZ(qreal);
  122. qreal rotation() const;
  123. void setRotation(qreal);
  124. qreal scale() const;
  125. void setScale(qreal);
  126. qreal opacity() const;
  127. void setOpacity(qreal);
  128. bool isVisible() const;
  129. void setVisible(bool);
  130. bool isEnabled() const;
  131. void setEnabled(bool);
  132. bool smooth() const;
  133. void setSmooth(bool);
  134. bool antialiasing() const;
  135. void setAntialiasing(bool);
  136. QQuickItem::Flags flags() const;
  137. void setFlag(QQuickItem::Flag flag, bool enabled = true);
  138. void setFlags(QQuickItem::Flags flags);
  139. bool hasActiveFocus() const;
  140. bool hasFocus() const;
  141. void setFocus(bool);
  142. bool isFocusScope() const;
  143. QQuickItem *scopedFocusItem() const;
  144. Qt::MouseButtons acceptedMouseButtons() const;
  145. void setAcceptedMouseButtons(Qt::MouseButtons buttons);
  146. bool acceptHoverEvents() const;
  147. void setAcceptHoverEvents(bool enabled);
  148. QCursor cursor() const;
  149. void setCursor(const QCursor &cursor);
  150. void unsetCursor();
  151. void grabMouse();
  152. void ungrabMouse();
  153. bool keepMouseGrab() const;
  154. void setKeepMouseGrab(bool);
  155. bool filtersChildMouseEvents() const;
  156. void setFiltersChildMouseEvents(bool filter);
  157. void grabTouchPoints(const QList<int> &ids);
  158. void ungrabTouchPoints();
  159. bool keepTouchGrab() const;
  160. void setKeepTouchGrab(bool);
  161. virtual bool contains(const QPointF &point) const;
  162. QPointF mapToItem(const QQuickItem *item, const QPointF &point) const;
  163. QPointF mapToScene(const QPointF &point) const;
  164. QRectF mapRectToItem(const QQuickItem *item, const QRectF &rect) const;
  165. QRectF mapRectToScene(const QRectF &rect) const;
  166. QPointF mapFromItem(const QQuickItem *item, const QPointF &point) const;
  167. QPointF mapFromScene(const QPointF &point) const;
  168. QRectF mapRectFromItem(const QQuickItem *item, const QRectF &rect) const;
  169. QRectF mapRectFromScene(const QRectF &rect) const;
  170. void polish();
  171. void forceActiveFocus();
  172. QQuickItem *childAt(qreal x, qreal y) const;
  173. virtual QVariant inputMethodQuery(Qt::InputMethodQuery query) const;
  174. struct UpdatePaintNodeData
  175. {
  176. %TypeHeaderCode
  177. #include <qquickitem.h>
  178. %End
  179. QSGTransformNode *transformNode;
  180. private:
  181. UpdatePaintNodeData();
  182. };
  183. virtual bool isTextureProvider() const;
  184. virtual QSGTextureProvider *textureProvider() const;
  185. public slots:
  186. void update() /ReleaseGIL/;
  187. signals:
  188. void childrenRectChanged(const QRectF &);
  189. void baselineOffsetChanged(qreal);
  190. void stateChanged(const QString &);
  191. void focusChanged(bool);
  192. void activeFocusChanged(bool);
  193. void parentChanged(QQuickItem *);
  194. void transformOriginChanged(QQuickItem::TransformOrigin);
  195. void smoothChanged(bool);
  196. void antialiasingChanged(bool);
  197. void clipChanged(bool);
  198. void opacityChanged();
  199. void enabledChanged();
  200. void visibleChanged();
  201. void rotationChanged();
  202. void scaleChanged();
  203. void xChanged();
  204. void yChanged();
  205. void widthChanged();
  206. void heightChanged();
  207. void zChanged();
  208. void implicitWidthChanged();
  209. void implicitHeightChanged();
  210. protected:
  211. virtual bool event(QEvent *);
  212. bool isComponentComplete() const;
  213. virtual void itemChange(QQuickItem::ItemChange, const QQuickItem::ItemChangeData &);
  214. void updateInputMethod(Qt::InputMethodQueries queries = Qt::ImQueryInput);
  215. bool widthValid() const;
  216. bool heightValid() const;
  217. virtual void classBegin();
  218. virtual void componentComplete();
  219. virtual void keyPressEvent(QKeyEvent *event);
  220. virtual void keyReleaseEvent(QKeyEvent *event);
  221. virtual void inputMethodEvent(QInputMethodEvent *);
  222. virtual void focusInEvent(QFocusEvent *);
  223. virtual void focusOutEvent(QFocusEvent *);
  224. virtual void mousePressEvent(QMouseEvent *event);
  225. virtual void mouseMoveEvent(QMouseEvent *event);
  226. virtual void mouseReleaseEvent(QMouseEvent *event);
  227. virtual void mouseDoubleClickEvent(QMouseEvent *event);
  228. virtual void mouseUngrabEvent();
  229. virtual void touchUngrabEvent();
  230. virtual void wheelEvent(QWheelEvent *event);
  231. virtual void touchEvent(QTouchEvent *event);
  232. virtual void hoverEnterEvent(QHoverEvent *event);
  233. virtual void hoverMoveEvent(QHoverEvent *event);
  234. virtual void hoverLeaveEvent(QHoverEvent *event);
  235. virtual void dragEnterEvent(QDragEnterEvent *);
  236. virtual void dragMoveEvent(QDragMoveEvent *);
  237. virtual void dragLeaveEvent(QDragLeaveEvent *);
  238. virtual void dropEvent(QDropEvent *);
  239. virtual bool childMouseEventFilter(QQuickItem *, QEvent *);
  240. virtual void geometryChange(const QRectF &newGeometry, const QRectF &oldGeometry);
  241. virtual QSGNode *updatePaintNode(QSGNode *, QQuickItem::UpdatePaintNodeData *);
  242. %VirtualCatcherCode
  243. PyObject *res;
  244. res = sipCallMethod(&sipIsErr, sipMethod, "DD",
  245. a0, sipType_QSGNode, NULL,
  246. a1, sipType_QQuickItem_UpdatePaintNodeData, NULL);
  247. if (res)
  248. {
  249. sipParseResult(&sipIsErr, sipMethod, res, "H0", sipType_QSGNode, &sipRes);
  250. if (!sipIsErr && sipRes && (sipRes->flags() & QSGNode::OwnedByParent))
  251. sipTransferTo(res, (PyObject *)sipPySelf);
  252. Py_DECREF(res);
  253. }
  254. %End
  255. virtual void releaseResources();
  256. virtual void updatePolish();
  257. public:
  258. bool activeFocusOnTab() const;
  259. void setActiveFocusOnTab(bool);
  260. void setFocus(bool focus, Qt::FocusReason reason);
  261. void forceActiveFocus(Qt::FocusReason reason);
  262. QQuickItem *nextItemInFocusChain(bool forward = true);
  263. signals:
  264. void activeFocusOnTabChanged(bool);
  265. void windowChanged(QQuickWindow *window);
  266. public:
  267. void resetAntialiasing();
  268. QQuickItemGrabResult *grabToImage(const QSize &targetSize = QSize()) /Factory/;
  269. %MethodCode
  270. QSharedPointer<QQuickItemGrabResult> *grab;
  271. Py_BEGIN_ALLOW_THREADS
  272. // This will leak but there seems to be no way to detach the object.
  273. grab = new QSharedPointer<QQuickItemGrabResult>(sipCpp->grabToImage(*a0));
  274. Py_END_ALLOW_THREADS
  275. sipRes = grab->data();
  276. %End
  277. bool isAncestorOf(const QQuickItem *child) const;
  278. QPointF mapToGlobal(const QPointF &point) const;
  279. QPointF mapFromGlobal(const QPointF &point) const;
  280. QSizeF size() const;
  281. bool acceptTouchEvents() const;
  282. void setAcceptTouchEvents(bool accept);
  283. QObject *containmentMask() const;
  284. void setContainmentMask(QObject *mask /KeepReference/);
  285. signals:
  286. void containmentMaskChanged();
  287. public:
  288. %If (Qt_6_3_0 -)
  289. QQuickItem *viewportItem() const;
  290. %End
  291. %If (Qt_6_3_0 -)
  292. void ensurePolished();
  293. %End
  294. %If (Qt_6_3_0 -)
  295. void dumpItemTree() const;
  296. %End
  297. %If (Qt_6_7_0 -)
  298. Qt::FocusPolicy focusPolicy() const;
  299. %End
  300. %If (Qt_6_7_0 -)
  301. void setFocusPolicy(Qt::FocusPolicy policy);
  302. %End
  303. signals:
  304. %If (Qt_6_7_0 -)
  305. void focusPolicyChanged(Qt::FocusPolicy);
  306. %End
  307. };