summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo Parente Lima <hugo.pl@gmail.com>2011-01-12 12:31:59 -0200
committerHugo Parente Lima <hugo.pl@gmail.com>2012-03-08 16:51:46 -0300
commitbcad6d0392ace27a9a4acb0097f2e170cb5f6e21 (patch)
tree636a6b49d4714b0521ea59a33c5c056268719e8f
parenta24e8ed2811a9d4f116d3c2e05721a4e47b7a09f (diff)
Fix documentation for QWidget.winId()
-rw-r--r--PySide/QtGui/typesystem_gui_common.xml13
1 files changed, 13 insertions, 0 deletions
diff --git a/PySide/QtGui/typesystem_gui_common.xml b/PySide/QtGui/typesystem_gui_common.xml
index 1d1ea011..37ffb89d 100644
--- a/PySide/QtGui/typesystem_gui_common.xml
+++ b/PySide/QtGui/typesystem_gui_common.xml
@@ -3475,6 +3475,19 @@
<parent index="1" action="add"/>
</modify-argument>
</modify-function>
+ <modify-function signature="winId()const">
+ <inject-documentation mode="replace" format="target">
+ Returns the window system identifier of the widget.
+
+ Portable in principle, but if you use it you are probably about to do something non-portable. Be careful.
+
+ If a widget is non-native (alien) and winId() is invoked on it, that widget will be provided a native handle.
+
+ On X11 the type returned is long, on other platforms it's a PyCObject.
+
+ This value may change at run-time. An event with type PySide.QtCore.QEvent.WinIdChange will be sent to the widget following a change in window system identifier.
+ </inject-documentation>
+ </modify-function>
</object-type>
<object-type name="QMessageBox">
<enum-type name="ButtonRole"/>