aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2023-08-04 13:03:54 +0200
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2023-08-07 23:02:06 +0200
commit7a24a59dbb343d86d733ce5613b57aaea429eeea (patch)
tree68a6c2eb378946a325e0917d931137337f467473 /sources/pyside6
parent22d1beb745917f3c00a484ceea61980ee3a83012 (diff)
Fix documentation for QPainter.drawText()
Inject Documentation and fix the snippet to indicate the QRect return. Task-number: PYSIDE-2411 Pick-to: 6.5 Change-Id: Id52f4c0a875301c6eac4a1d33034a04fa652e0d5 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Diffstat (limited to 'sources/pyside6')
-rw-r--r--sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml9
-rw-r--r--sources/pyside6/doc/snippets/qtbase/src/gui/doc/snippets/code/src_gui_painting_qpainter_drawText.cpp.py13
2 files changed, 22 insertions, 0 deletions
diff --git a/sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml b/sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml
index 984a28ecf..8ac86054b 100644
--- a/sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml
+++ b/sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml
@@ -1936,6 +1936,9 @@
<inject-code class="target" position="beginning">
<insert-template name="fix_args,QRectF*"/>
</inject-code>
+ <inject-documentation format="target" mode="prepend">
+ The function returns the bounding rectangle enclosing the whole text.
+ </inject-documentation>
</modify-function>
<modify-function signature="drawText(QRect,int,QString,QRect*)">
<modify-argument index="4">
@@ -1948,6 +1951,9 @@
<inject-code class="target" position="beginning">
<insert-template name="fix_args,QRect*"/>
</inject-code>
+ <inject-documentation format="target" mode="prepend">
+ The function returns the bounding rectangle enclosing the whole text.
+ </inject-documentation>
</modify-function>
<modify-function signature="drawText(int,int,int,int,int,QString,QRect*)">
<modify-argument index="7">
@@ -1957,6 +1963,9 @@
<inject-code class="target" position="beginning">
<insert-template name="fix_args,QRect*"/>
</inject-code>
+ <inject-documentation format="target" mode="prepend">
+ The function returns the bounding rectangle enclosing the whole text.
+ </inject-documentation>
</modify-function>
<add-function signature="__enter__()" return-type="QPainter">
<inject-code file="../glue/qtgui.cpp" snippet="qpainter-enter"/>
diff --git a/sources/pyside6/doc/snippets/qtbase/src/gui/doc/snippets/code/src_gui_painting_qpainter_drawText.cpp.py b/sources/pyside6/doc/snippets/qtbase/src/gui/doc/snippets/code/src_gui_painting_qpainter_drawText.cpp.py
new file mode 100644
index 000000000..cad2c5395
--- /dev/null
+++ b/sources/pyside6/doc/snippets/qtbase/src/gui/doc/snippets/code/src_gui_painting_qpainter_drawText.cpp.py
@@ -0,0 +1,13 @@
+painter = QPainter(self)
+font = painter.font()
+font.setPixelSize(48)
+painter.setFont(font)
+rectangle = QRect(0, 0, 100, 50)
+boundingRect = painter.drawText(rectangle, 0, "Hello")
+pen = painter.pen()
+pen.setStyle(Qt.DotLine)
+painter.setPen(pen)
+painter.drawRect(boundingRect.adjusted(0, 0, -pen.width(), -pen.width()))
+pen.setStyle(Qt.DashLine)
+painter.setPen(pen)
+painter.drawRect(rectangle.adjusted(0, 0, -pen.width(), -pen.width()))