aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Faure <faure@kde.org>2017-12-08 13:05:16 +0100
committerDavid Faure <faure@kde.org>2017-12-08 13:05:16 +0100
commit9dd072ae3680a96e52a1704caa843a198cd459dc (patch)
tree81c37810a702d71d4921012c1122078bc3a26acd
parenta69d8e562b6e91844f7e51b0b6c0545cc54ae840 (diff)
downloadkconfig-9dd072ae3680a96e52a1704caa843a198cd459dc.tar.gz
kconfig-9dd072ae3680a96e52a1704caa843a198cd459dc.tar.bz2
API docs: explain how to use KWindowConfig from a dialog constructor.
Qt doesn't make it easy for us to just use QWindow...
-rw-r--r--src/gui/kwindowconfig.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/gui/kwindowconfig.h b/src/gui/kwindowconfig.h
index 49f14f96..7879daba 100644
--- a/src/gui/kwindowconfig.h
+++ b/src/gui/kwindowconfig.h
@@ -49,6 +49,10 @@ KCONFIGGUI_EXPORT void saveWindowSize(const QWindow *window, KConfigGroup &confi
* Restores the dialog's size from the configuration according to
* the screen size.
*
+ * If you're calling this from a constructor (for a mainwindow or dialog, for instance)
+ * you should first call winId() so that a QWindow is created, then you can call windowHandle()
+ * to pass to this method.
+ *
* @note the group must be set before calling
*
* @param window The window to restore size.